Compare commits
9 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| e3bbd13ed8 | |||
| 1877bac7ce | |||
| c06538a725 | |||
| a08b0c4eea | |||
| 1b03ae875b | |||
| af1da75a82 | |||
| e19768688d | |||
| 6d706d4c15 | |||
| 97f2bcce2e |
16
index.html
16
index.html
@ -1,15 +1,19 @@
|
||||
<html>
|
||||
<body>
|
||||
<script type="module">
|
||||
import {Cache, Collection} from './dist/index.mjs';
|
||||
import {Cache, Database} from './dist/index.mjs';
|
||||
|
||||
const cache = new Cache('id', {
|
||||
ttl: 60,
|
||||
storage: new Collection('test', 'test'),
|
||||
expiryPolicy: 'delete'
|
||||
const db = new Database('test');
|
||||
db.connection.then(() => {
|
||||
console.log(db.tables);
|
||||
});
|
||||
|
||||
cache.add({id: 1, name: 'zak', age: 27});
|
||||
const table = window.table = await db.createTable('test2');
|
||||
table.add({ name: 'Alice', age: 30 });
|
||||
table.add({ name: 'Bob', age: 24 });
|
||||
table.add({ name: 'Carol', age: 30 });
|
||||
|
||||
console.log(db.tables);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@ztimson/utils",
|
||||
"version": "0.25.1",
|
||||
"version": "0.25.10",
|
||||
"description": "Utility library",
|
||||
"author": "Zak Timson",
|
||||
"license": "MIT",
|
||||
|
||||
19
src/cache.ts
19
src/cache.ts
@ -1,11 +1,11 @@
|
||||
import {Collection} from './database.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 | Collection<any, any>;
|
||||
storage?: Storage | Table<any, any>;
|
||||
/** Key cache will be stored under */
|
||||
storageKey?: string;
|
||||
/** Keep or delete cached items once expired, defaults to delete */
|
||||
@ -33,10 +33,8 @@ export class Cache<K extends string | number | symbol, T> {
|
||||
constructor(public readonly key?: keyof T, public readonly options: CacheOptions = {}) {
|
||||
if(options.storageKey && !options.storage && typeof(Storage) !== 'undefined') options.storage = localStorage;
|
||||
if(options.storage) {
|
||||
if(options.storage instanceof Collection) {
|
||||
(async () => {
|
||||
(await options.storage?.getAll()).forEach((v: any) => this.add(v));
|
||||
})()
|
||||
if(options.storage instanceof Table) {
|
||||
(async () => (await options.storage?.getAll()).forEach((v: any) => 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 { }
|
||||
@ -62,7 +60,7 @@ export class Cache<K extends string | number | symbol, T> {
|
||||
|
||||
private save(key: K) {
|
||||
if(this.options.storage) {
|
||||
if(this.options.storage instanceof Collection) {
|
||||
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));
|
||||
@ -138,14 +136,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 {
|
||||
|
||||
161
src/database.ts
161
src/database.ts
@ -1,60 +1,157 @@
|
||||
export class Collection<K extends IDBValidKey, T> {
|
||||
private database: Promise<IDBDatabase>;
|
||||
import {findByProp} from './array.ts';
|
||||
import {ASet} from './aset.ts';
|
||||
|
||||
export type TableOptions = {
|
||||
name: string;
|
||||
key?: string;
|
||||
autoIncrement?: boolean;
|
||||
};
|
||||
|
||||
export class Database {
|
||||
connection!: Promise<IDBDatabase>;
|
||||
ready = false;
|
||||
tables!: TableOptions[];
|
||||
|
||||
constructor(public readonly database: string, tables?: (string | TableOptions)[], public version?: number) {
|
||||
this.connection = new Promise((resolve, reject) => {
|
||||
const req = indexedDB.open(this.database, this.version);
|
||||
this.tables = !tables ? [] : tables.map(t => {
|
||||
t = typeof t == 'object' ? t : {name: t};
|
||||
return {...t, name: t.name.toString()};
|
||||
});
|
||||
|
||||
constructor(public readonly db: string, public readonly collection: string, public readonly version?: number, private setup?: (db: IDBDatabase, event: IDBVersionChangeEvent) => void) {
|
||||
this.database = new Promise((resolve, reject) => {
|
||||
const req = indexedDB.open(this.db, this.version);
|
||||
req.onerror = () => reject(req.error);
|
||||
req.onsuccess = () => resolve(req.result);
|
||||
req.onupgradeneeded = (event) => {
|
||||
|
||||
req.onsuccess = () => {
|
||||
const db = req.result;
|
||||
if(!db.objectStoreNames.contains(collection)) db.createObjectStore(collection, {keyPath: undefined});
|
||||
if (this.setup) this.setup(db, event as IDBVersionChangeEvent);
|
||||
const existing = Array.from(db.objectStoreNames);
|
||||
if(!tables) this.tables = existing.map(t => {
|
||||
const tx = db.transaction(t, 'readonly', )
|
||||
const store = tx.objectStore(t);
|
||||
return {name: t, key: <string>store.keyPath};
|
||||
});
|
||||
const desired = new ASet((tables || []).map(t => typeof t == 'string' ? t : t.name));
|
||||
if(tables && desired.symmetricDifference(new ASet(existing)).length) {
|
||||
db.close();
|
||||
Object.assign(this, new Database(this.database, this.tables, db.version + 1));
|
||||
this.connection.then(resolve);
|
||||
} else {
|
||||
this.version = db.version;
|
||||
resolve(db);
|
||||
}
|
||||
this.ready = true;
|
||||
};
|
||||
|
||||
req.onupgradeneeded = () => {
|
||||
const db = req.result;
|
||||
const existingTables = new ASet(Array.from(db.objectStoreNames));
|
||||
if(tables) {
|
||||
const desired = new ASet((tables || []).map(t => typeof t == 'string' ? t : t.name));
|
||||
existingTables.difference(desired).forEach(name => db.deleteObjectStore(name));
|
||||
desired.difference(existingTables).forEach(name => {
|
||||
const t = this.tables.find(findByProp('name', name));
|
||||
db.createObjectStore(name, {
|
||||
keyPath: t?.key,
|
||||
autoIncrement: t?.autoIncrement || !t?.key
|
||||
});
|
||||
});
|
||||
}
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
async tx<T>(collection: string, fn: ((store: IDBObjectStore) => IDBRequest), readonly?: boolean): Promise<T> {
|
||||
const db = await this.database;
|
||||
const tx = db.transaction(collection, readonly ? 'readonly' : 'readwrite');
|
||||
const store = tx.objectStore(collection);
|
||||
return new Promise((resolve, reject) => {
|
||||
async createTable<K extends IDBValidKey = any, T = any>(table: string | TableOptions): Promise<Table<K, T>> {
|
||||
if(typeof table == 'string') table = {name: table};
|
||||
const conn = await this.connection;
|
||||
if(!this.includes(table.name)) {
|
||||
conn.close();
|
||||
Object.assign(this, new Database(this.database, [...this.tables, table], (this.version ?? 0) + 1));
|
||||
}
|
||||
return this.table<K, T>(table.name);
|
||||
}
|
||||
|
||||
async deleteTable(table: string | TableOptions): Promise<void> {
|
||||
if(typeof table == 'string') table = {name: table};
|
||||
if(!this.includes(table.name)) return;
|
||||
const conn = await this.connection;
|
||||
conn.close();
|
||||
Object.assign(this, new Database(this.database, this.tables.filter(t => t.name != table.name), (this.version ?? 0) + 1));
|
||||
}
|
||||
|
||||
includes(name: any): boolean {
|
||||
return !!this.tables.find(t => t.name == (typeof name == 'object' ? name.name : name.toString()));
|
||||
}
|
||||
|
||||
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, public readonly key: keyof T | string = 'id') {
|
||||
this.database.connection.then(() => {
|
||||
const exists = !!this.database.tables.find(findByProp('name', this.name));
|
||||
if(!exists) this.database.createTable(this.name);
|
||||
});
|
||||
}
|
||||
|
||||
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);
|
||||
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.collection, store => store.add(value, key));
|
||||
return this.tx(this.name, store => store.add(value, key));
|
||||
}
|
||||
|
||||
all = this.getAll;
|
||||
|
||||
clear(): Promise<void> {
|
||||
return this.tx(this.name, store => store.clear());
|
||||
}
|
||||
|
||||
count(): Promise<number> {
|
||||
return this.tx(this.collection, store => store.count(), true);
|
||||
return this.tx(this.name, store => store.count(), true);
|
||||
}
|
||||
|
||||
put(key: K, value: T): Promise<void> {
|
||||
debugger;
|
||||
return this.tx(this.collection, store => store.put(value, key));
|
||||
}
|
||||
create = this.add;
|
||||
|
||||
getAll(): Promise<T[]> {
|
||||
return this.tx(this.collection, store => store.getAll(), true);
|
||||
}
|
||||
|
||||
getAllKeys(): Promise<K[]> {
|
||||
return this.tx(this.collection, store => store.getAllKeys(), true);
|
||||
delete(key: K): Promise<void> {
|
||||
return this.tx(this.name, store => store.delete(key));
|
||||
}
|
||||
|
||||
get(key: K): Promise<T> {
|
||||
return this.tx(this.collection, store => store.get(key), true);
|
||||
return this.tx(this.name, store => store.get(key), true);
|
||||
}
|
||||
|
||||
delete(key: K): Promise<void> {
|
||||
return this.tx(this.collection, store => store.delete(key));
|
||||
getAll(): Promise<T[]> {
|
||||
return this.tx(this.name, store => store.getAll(), true);
|
||||
}
|
||||
|
||||
clear(): Promise<void> {
|
||||
return this.tx(this.collection, store => store.clear());
|
||||
getAllKeys(): Promise<K[]> {
|
||||
return this.tx(this.name, store => store.getAllKeys(), true);
|
||||
}
|
||||
|
||||
put(key: K, value: T): Promise<void> {
|
||||
return this.tx(this.name, store => store.put(value, key));
|
||||
}
|
||||
|
||||
read(): Promise<T[]>;
|
||||
read(key: K): Promise<T>;
|
||||
read(key?: K): Promise<T | T[]> {
|
||||
return key ? this.get(key) : this.getAll();
|
||||
}
|
||||
|
||||
set(value: T, key?: K): Promise<void> {
|
||||
if(!key && !(<any>value)[this.key]) return this.add(value);
|
||||
return this.put(key || (<any>value)[this.key], value);
|
||||
}
|
||||
|
||||
update = this.set;
|
||||
}
|
||||
|
||||
@ -21,11 +21,13 @@ export const CHAR_LIST = LETTER_LIST + LETTER_LIST.toLowerCase() + NUMBER_LIST +
|
||||
/**
|
||||
* Converts text to camelCase
|
||||
*/
|
||||
export function camelCase(str?: string) {
|
||||
const text = pascalCase(str);
|
||||
return !text ? '' : text[0].toLowerCase() + text.slice(1);
|
||||
export function camelCase(str?: string): string {
|
||||
if(!str) return '';
|
||||
const pascal = pascalCase(str);
|
||||
return pascal.charAt(0).toLowerCase() + pascal.slice(1);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Convert number of bytes into a human-readable size
|
||||
*
|
||||
@ -75,14 +77,12 @@ export function insertAt(target: string, str: string, index: number): String {
|
||||
/**
|
||||
* Converts text to kebab-case
|
||||
*/
|
||||
export function kebabCase(str: string) {
|
||||
export function kebabCase(str?: string): string {
|
||||
if(!str) return '';
|
||||
return str.replaceAll(/(^[^a-zA-Z]+|[^a-zA-Z0-9-_])/g, '')
|
||||
.replaceAll(/([A-Z]|[0-9]+)/g, (...args) => `-${args[0].toLowerCase()}`)
|
||||
.replaceAll(/([0-9])([a-z])/g, (...args) => `${args[1]}-${args[2]}`)
|
||||
.replaceAll(/[^a-z0-9]+(\w?)/g, (...args) => `-${args[1] ?? ''}`).toLowerCase();
|
||||
return wordSegments(str).map(w => w.toLowerCase()).join("-");
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Add padding to string
|
||||
*
|
||||
@ -112,12 +112,13 @@ export function pad(text: any, length: number, char: string = ' ', start = true)
|
||||
*/
|
||||
export function pascalCase(str?: string): string {
|
||||
if(!str) return '';
|
||||
return str.match(/[a-zA-Z0-9]+/g)
|
||||
?.map(word => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
|
||||
.join('') ?? '';
|
||||
return wordSegments(str)
|
||||
.map((w) => w.charAt(0).toUpperCase() + w.slice(1).toLowerCase())
|
||||
.join('');
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Generate a random hexadecimal value
|
||||
*
|
||||
@ -184,14 +185,12 @@ export function randomStringBuilder(length: number, letters = false, numbers = f
|
||||
/**
|
||||
* Converts text to snake_case
|
||||
*/
|
||||
export function snakeCase(str?: string) {
|
||||
export function snakeCase(str?: string): string {
|
||||
if(!str) return '';
|
||||
return str.replaceAll(/(^[^a-zA-Z]+|[^a-zA-Z0-9-_])/g, '')
|
||||
.replaceAll(/([A-Z]|[0-9]+)/g, (...args) => `_${args[0].toLowerCase()}`)
|
||||
.replaceAll(/([0-9])([a-z])/g, (...args) => `${args[1]}_${args[2]}`)
|
||||
.replaceAll(/[^a-z0-9]+(\w?)/g, (...args) => `_${args[1] ?? ''}`).toLowerCase();
|
||||
return wordSegments(str).map(w => w.toLowerCase()).join("_");
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Splice a string together (Similar to Array.splice)
|
||||
*
|
||||
@ -298,6 +297,23 @@ export function md5(d: string) {
|
||||
function bit_rol(d:any,_:any){return d<<_|d>>>32-_
|
||||
}
|
||||
|
||||
/**
|
||||
* Splits a string into logical word segments
|
||||
*/
|
||||
export function wordSegments(str?: string): string[] {
|
||||
if (!str) return [];
|
||||
return str
|
||||
.replace(/([a-z])([A-Z])/g, "$1 $2")
|
||||
.replace(/([A-Z]+)([A-Z][a-z])/g, "$1 $2")
|
||||
.replace(/([0-9]+)([a-zA-Z])/g, "$1 $2")
|
||||
.replace(/([a-zA-Z])([0-9]+)/g, "$1 $2")
|
||||
.replace(/[_\-\s]+/g, " ")
|
||||
.trim()
|
||||
.split(/\s+/)
|
||||
.filter(Boolean);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Check if email is valid
|
||||
*
|
||||
|
||||
@ -1,65 +0,0 @@
|
||||
import {Collection} from '../src';
|
||||
import 'fake-indexeddb/auto';
|
||||
|
||||
describe('IndexedDb and Collection', () => {
|
||||
const data = {id: 1, name: 'Alice', age: 30, email: '<EMAIL>'};
|
||||
const data2 = {id: 2, name: 'Bob', age: 39, email: '<EMAIL>'};
|
||||
let collection = new Collection<number, typeof data>('database', 'collection');
|
||||
|
||||
afterEach(() => collection.clear());
|
||||
|
||||
test('can set and get an item', async () => {
|
||||
await collection.put(data.id, data);
|
||||
const result = await collection.get(data.id);
|
||||
expect(result).toEqual(data);
|
||||
});
|
||||
|
||||
test('can remove an item', async () => {
|
||||
await collection.put(data.id, data);
|
||||
await collection.put(data2.id, data2);
|
||||
await collection.delete(data.id);
|
||||
const result = await collection.get(data.id);
|
||||
const result2 = await collection.get(data2.id);
|
||||
expect(result).toBeUndefined();
|
||||
expect(result2).toEqual(data2);
|
||||
});
|
||||
|
||||
test('can clear all items', async () => {
|
||||
await collection.put(data.id, data);
|
||||
await collection.put(data2.id, data2);
|
||||
await collection.clear();
|
||||
const result = await collection.get(data.id);
|
||||
const result2 = await collection.get(data2.id);
|
||||
expect(result).toBeUndefined();
|
||||
expect(result2).toBeUndefined();
|
||||
});
|
||||
|
||||
test('getItem on missing key returns undefined', async () => {
|
||||
const result = await collection.get(-1);
|
||||
expect(result).toBeUndefined();
|
||||
});
|
||||
|
||||
test('count returns number of items', async () => {
|
||||
expect(await collection.count()).toBe(0);
|
||||
await collection.put(data.id, data);
|
||||
expect(await collection.count()).toBe(1);
|
||||
await collection.delete(data.id);
|
||||
expect(await collection.count()).toBe(0);
|
||||
});
|
||||
|
||||
test('can get all items', async () => {
|
||||
await collection.put(data.id, data);
|
||||
await collection.put(data2.id, data2);
|
||||
const allItems = await collection.getAll();
|
||||
expect(allItems).toEqual(expect.arrayContaining([data, data2]));
|
||||
expect(allItems.length).toBe(2);
|
||||
});
|
||||
|
||||
test('can get all keys', async () => {
|
||||
await collection.put(data.id, data);
|
||||
await collection.put(data2.id, data2);
|
||||
const keys = await collection.getAllKeys();
|
||||
expect(keys).toEqual(expect.arrayContaining([data.id, data2.id]));
|
||||
expect(keys.length).toBe(2);
|
||||
});
|
||||
});
|
||||
@ -59,7 +59,8 @@ describe('String Utilities', () => {
|
||||
|
||||
describe('kebabCase', () => {
|
||||
it('converts to kebab-case', () => {
|
||||
expect(kebabCase('HelloWorldTest')).toContain('-hello');
|
||||
expect(kebabCase('hello world')).toBe('hello-world');
|
||||
expect(kebabCase('HelloWorld')).toContain('hello-world');
|
||||
expect(kebabCase('')).toBe('');
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user