Compare commits
8 Commits
Author | SHA1 | Date | |
---|---|---|---|
c06538a725 | |||
a08b0c4eea | |||
1b03ae875b | |||
af1da75a82 | |||
e19768688d | |||
6d706d4c15 | |||
97f2bcce2e | |||
2a7fa18c0e |
10
index.html
Normal file
10
index.html
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
<html>
|
||||||
|
<body>
|
||||||
|
<script type="module">
|
||||||
|
import {Cache, Database} from './dist/index.mjs';
|
||||||
|
|
||||||
|
const db = new Database('test', [123]);
|
||||||
|
window['table'] = db.table(123);
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@ztimson/utils",
|
"name": "@ztimson/utils",
|
||||||
"version": "0.25.0",
|
"version": "0.25.8",
|
||||||
"description": "Utility library",
|
"description": "Utility library",
|
||||||
"author": "Zak Timson",
|
"author": "Zak Timson",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
@ -31,6 +31,7 @@
|
|||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/jest": "^29.5.12",
|
"@types/jest": "^29.5.12",
|
||||||
|
"fake-indexeddb": "^6.0.1",
|
||||||
"jest": "^29.7.0",
|
"jest": "^29.7.0",
|
||||||
"jest-junit": "^16.0.0",
|
"jest-junit": "^16.0.0",
|
||||||
"ts-jest": "^29.1.2",
|
"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 = {
|
export type CacheOptions = {
|
||||||
/** Delete keys automatically after x amount of seconds */
|
/** Delete keys automatically after x amount of seconds */
|
||||||
ttl?: number;
|
ttl?: number;
|
||||||
/** Storage to persist cache */
|
/** Storage to persist cache */
|
||||||
storage?: Storage;
|
storage?: Storage | Table<any, any>;
|
||||||
/** Key cache will be stored under */
|
/** Key cache will be stored under */
|
||||||
storageKey?: string;
|
storageKey?: string;
|
||||||
/** Keep or delete cached items once expired, defaults to delete */
|
/** 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
|
* @param options
|
||||||
*/
|
*/
|
||||||
constructor(public readonly key?: keyof T, public readonly options: CacheOptions = {}) {
|
constructor(public readonly key?: keyof T, public readonly options: CacheOptions = {}) {
|
||||||
if(options.storageKey && !options.storage && typeof(Storage) !== 'undefined')
|
if(options.storageKey && !options.storage && typeof(Storage) !== 'undefined') options.storage = localStorage;
|
||||||
options.storage = localStorage;
|
if(options.storage) {
|
||||||
if(options.storageKey && options.storage) {
|
if(options.storage instanceof Table) {
|
||||||
const stored = options.storage.getItem(options.storageKey);
|
(async () => (await options.storage?.getAll()).forEach((v: any) => {
|
||||||
if(stored) {
|
console.log(v);
|
||||||
try { Object.assign(this.store, JSON.parse(stored)); }
|
this.add(v)
|
||||||
catch { }
|
}))()
|
||||||
|
} 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, {
|
return new Proxy(this, {
|
||||||
@ -57,9 +61,14 @@ export class Cache<K extends string | number | symbol, T> {
|
|||||||
return <K>value[this.key];
|
return <K>value[this.key];
|
||||||
}
|
}
|
||||||
|
|
||||||
private save() {
|
private save(key: K) {
|
||||||
if(this.options.storageKey && this.options.storage)
|
if(this.options.storage) {
|
||||||
this.options.storage.setItem(this.options.storageKey, JSON.stringify(this.store));
|
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(key: K): this {
|
||||||
delete this.store[key];
|
delete this.store[key];
|
||||||
this.save();
|
this.save(key);
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -130,14 +139,17 @@ export class Cache<K extends string | number | symbol, T> {
|
|||||||
*/
|
*/
|
||||||
expire(key: K): this {
|
expire(key: K): this {
|
||||||
this.complete = false;
|
this.complete = false;
|
||||||
if(this.options.expiryPolicy == 'keep') (<any>this.store[key])._expired = true;
|
if(this.options.expiryPolicy == 'keep') {
|
||||||
else this.delete(key);
|
(<any>this.store[key])._expired = true;
|
||||||
|
this.save(key);
|
||||||
|
} else this.delete(key);
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get item from the cache
|
* Get item from the cache
|
||||||
* @param {K} key Key to lookup
|
* @param {K} key Key to lookup
|
||||||
|
* @param expired Include expired items
|
||||||
* @return {T} Cached item
|
* @return {T} Cached item
|
||||||
*/
|
*/
|
||||||
get(key: K, expired?: boolean): CachedValue<T> | null {
|
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 {
|
set(key: K, value: T, ttl = this.options.ttl): this {
|
||||||
if(this.options.expiryPolicy == 'keep') delete (<any>value)._expired;
|
if(this.options.expiryPolicy == 'keep') delete (<any>value)._expired;
|
||||||
this.store[key] = value;
|
this.store[key] = value;
|
||||||
this.save();
|
this.save(key);
|
||||||
if(ttl) setTimeout(() => {
|
if(ttl) setTimeout(() => {
|
||||||
this.expire(key);
|
this.expire(key);
|
||||||
this.save();
|
this.save(key);
|
||||||
}, (ttl || 0) * 1000);
|
}, (ttl || 0) * 1000);
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
97
src/database.ts
Normal file
97
src/database.ts
Normal file
@ -0,0 +1,97 @@
|
|||||||
|
import {ASet} from './aset.ts';
|
||||||
|
|
||||||
|
export type TableOptions = {
|
||||||
|
name: string;
|
||||||
|
key?: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
export class Database {
|
||||||
|
connection!: Promise<IDBDatabase>;
|
||||||
|
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.map(t => {
|
||||||
|
t = typeof t == 'object' ? t : {name: t};
|
||||||
|
return {...t, name: t.name.toString()};
|
||||||
|
});
|
||||||
|
const tableNames = new ASet(this.tables.map(t => t.name));
|
||||||
|
|
||||||
|
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: any): boolean {
|
||||||
|
return !!this.tables.find(t => t.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) {}
|
||||||
|
|
||||||
|
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 './cache';
|
||||||
export * from './color';
|
export * from './color';
|
||||||
export * from './csv';
|
export * from './csv';
|
||||||
|
export * from './database';
|
||||||
export * from './files';
|
export * from './files';
|
||||||
export * from './emitter';
|
export * from './emitter';
|
||||||
export * from './errors';
|
export * from './errors';
|
||||||
|
@ -21,11 +21,13 @@ export const CHAR_LIST = LETTER_LIST + LETTER_LIST.toLowerCase() + NUMBER_LIST +
|
|||||||
/**
|
/**
|
||||||
* Converts text to camelCase
|
* Converts text to camelCase
|
||||||
*/
|
*/
|
||||||
export function camelCase(str?: string) {
|
export function camelCase(str?: string): string {
|
||||||
const text = pascalCase(str);
|
if(!str) return '';
|
||||||
return !text ? '' : text[0].toLowerCase() + text.slice(1);
|
const pascal = pascalCase(str);
|
||||||
|
return pascal.charAt(0).toLowerCase() + pascal.slice(1);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Convert number of bytes into a human-readable size
|
* 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
|
* Converts text to kebab-case
|
||||||
*/
|
*/
|
||||||
export function kebabCase(str: string) {
|
export function kebabCase(str?: string): string {
|
||||||
if(!str) return '';
|
if(!str) return '';
|
||||||
return str.replaceAll(/(^[^a-zA-Z]+|[^a-zA-Z0-9-_])/g, '')
|
return wordSegments(str).map(w => w.toLowerCase()).join("-");
|
||||||
.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();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Add padding to string
|
* 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 {
|
export function pascalCase(str?: string): string {
|
||||||
if(!str) return '';
|
if(!str) return '';
|
||||||
return str.match(/[a-zA-Z0-9]+/g)
|
return wordSegments(str)
|
||||||
?.map(word => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
|
.map((w) => w.charAt(0).toUpperCase() + w.slice(1).toLowerCase())
|
||||||
.join('') ?? '';
|
.join('');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Generate a random hexadecimal value
|
* Generate a random hexadecimal value
|
||||||
*
|
*
|
||||||
@ -184,14 +185,12 @@ export function randomStringBuilder(length: number, letters = false, numbers = f
|
|||||||
/**
|
/**
|
||||||
* Converts text to snake_case
|
* Converts text to snake_case
|
||||||
*/
|
*/
|
||||||
export function snakeCase(str?: string) {
|
export function snakeCase(str?: string): string {
|
||||||
if(!str) return '';
|
if(!str) return '';
|
||||||
return str.replaceAll(/(^[^a-zA-Z]+|[^a-zA-Z0-9-_])/g, '')
|
return wordSegments(str).map(w => w.toLowerCase()).join("_");
|
||||||
.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();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Splice a string together (Similar to Array.splice)
|
* 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-_
|
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
|
* Check if email is valid
|
||||||
*
|
*
|
||||||
|
@ -59,7 +59,8 @@ describe('String Utilities', () => {
|
|||||||
|
|
||||||
describe('kebabCase', () => {
|
describe('kebabCase', () => {
|
||||||
it('converts to kebab-case', () => {
|
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('');
|
expect(kebabCase('')).toBe('');
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
Reference in New Issue
Block a user