Compare commits
12 Commits
Author | SHA1 | Date | |
---|---|---|---|
adafd61c83 | |||
7747dc5558 | |||
947bdbc6d4 | |||
e2b8c35535 | |||
3b7d28de4b | |||
8f7e816571 | |||
8c1fb2d8cb | |||
91dc17667e | |||
11cfc67650 | |||
4ed23e1502 | |||
e3bbd13ed8 | |||
1877bac7ce |
@ -1,10 +1,9 @@
|
||||
<html>
|
||||
<body>
|
||||
<script type="module">
|
||||
import {Cache, Database} from './dist/index.mjs';
|
||||
import {PES} from './dist/index.mjs';
|
||||
|
||||
const db = new Database('test', [123]);
|
||||
window['table'] = db.table(123);
|
||||
console.log(PES`storage${'Test/Test'}:d`);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@ztimson/utils",
|
||||
"version": "0.25.8",
|
||||
"version": "0.25.18",
|
||||
"description": "Utility library",
|
||||
"author": "Zak Timson",
|
||||
"license": "MIT",
|
||||
|
19
src/cache.ts
19
src/cache.ts
@ -1,5 +1,5 @@
|
||||
import {Table} from './database.ts';
|
||||
import {deepCopy, JSONSanitize} from './objects.ts';
|
||||
import {deepCopy, includes, JSONSanitize} from './objects.ts';
|
||||
|
||||
export type CacheOptions = {
|
||||
/** Delete keys automatically after x amount of seconds */
|
||||
@ -35,8 +35,10 @@ export class Cache<K extends string | number | symbol, T> {
|
||||
if(options.storage) {
|
||||
if(options.storage instanceof Table) {
|
||||
(async () => (await options.storage?.getAll()).forEach((v: any) => {
|
||||
console.log(v);
|
||||
this.add(v)
|
||||
if(v) {
|
||||
try { this.add(v) }
|
||||
catch { }
|
||||
}
|
||||
}))()
|
||||
} else if(options.storageKey) {
|
||||
const stored = options.storage?.getItem(options.storageKey);
|
||||
@ -58,6 +60,7 @@ export class Cache<K extends string | number | symbol, T> {
|
||||
|
||||
private getKey(value: T): K {
|
||||
if(!this.key) throw new Error('No key defined');
|
||||
if(value[this.key] === undefined) throw new Error(`${this.key.toString()} Doesn't exist on ${JSON.stringify(value, null, 2)}`);
|
||||
return <K>value[this.key];
|
||||
}
|
||||
|
||||
@ -146,6 +149,16 @@ export class Cache<K extends string | number | symbol, T> {
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Find the first cached item to match a filter
|
||||
* @param {Partial<T>} filter Partial item to match
|
||||
* @param {Boolean} expired Include expired items, defaults to false
|
||||
* @returns {T | undefined} Cached item or undefined if nothing matched
|
||||
*/
|
||||
find(filter: Partial<T>, expired?: boolean): T | undefined {
|
||||
return <T>Object.values(this.store).find((row: any) => (expired || !row._expired) && includes(row, filter));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get item from the cache
|
||||
* @param {K} key Key to lookup
|
||||
|
@ -1,47 +1,85 @@
|
||||
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) {
|
||||
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 => {
|
||||
this.tables = !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) {
|
||||
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));
|
||||
existingTables.difference(tableNames).forEach(name => db.deleteObjectStore(name));
|
||||
tableNames.difference(existingTables).forEach(name => db.createObjectStore(name));
|
||||
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 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 == name.toString());
|
||||
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> {
|
||||
@ -50,7 +88,12 @@ export class Database {
|
||||
}
|
||||
|
||||
export class Table<K extends IDBValidKey = any, T = any> {
|
||||
constructor(private readonly database: Database, public readonly name: string) {}
|
||||
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;
|
||||
@ -67,12 +110,24 @@ export class Table<K extends IDBValidKey = any, T = any> {
|
||||
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.name, store => store.count(), true);
|
||||
}
|
||||
|
||||
put(key: K, value: T): Promise<void> {
|
||||
return this.tx(this.name, store => store.put(value, key));
|
||||
create = this.add;
|
||||
|
||||
delete(key: K): Promise<void> {
|
||||
return this.tx(this.name, store => store.delete(key));
|
||||
}
|
||||
|
||||
get(key: K): Promise<T> {
|
||||
return this.tx(this.name, store => store.get(key), true);
|
||||
}
|
||||
|
||||
getAll(): Promise<T[]> {
|
||||
@ -83,15 +138,20 @@ export class Table<K extends IDBValidKey = any, T = any> {
|
||||
return this.tx(this.name, store => store.getAllKeys(), true);
|
||||
}
|
||||
|
||||
get(key: K): Promise<T> {
|
||||
return this.tx(this.name, store => store.get(key), true);
|
||||
put(key: K, value: T): Promise<void> {
|
||||
return this.tx(this.name, store => store.put(value, key));
|
||||
}
|
||||
|
||||
delete(key: K): Promise<void> {
|
||||
return this.tx(this.name, store => store.delete(key));
|
||||
read(): Promise<T[]>;
|
||||
read(key: K): Promise<T>;
|
||||
read(key?: K): Promise<T | T[]> {
|
||||
return key ? this.get(key) : this.getAll();
|
||||
}
|
||||
|
||||
clear(): Promise<void> {
|
||||
return this.tx(this.name, store => store.clear());
|
||||
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;
|
||||
}
|
||||
|
@ -77,7 +77,7 @@ export function fileText(file: any): Promise<string | null> {
|
||||
*/
|
||||
export function timestampFilename(name?: string, date: Date | number | string = new Date()) {
|
||||
if(typeof date == 'number' || typeof date == 'string') date = new Date(date);
|
||||
const timestamp = formatDate('YYYY-MM-DD_HH:mm:ss', date);
|
||||
const timestamp = formatDate('YYYY-MM-DD_HH-mm', date);
|
||||
return name ? name.replace('{{TIMESTAMP}}', timestamp) : timestamp;
|
||||
}
|
||||
|
||||
|
24
src/misc.ts
24
src/misc.ts
@ -1,6 +1,16 @@
|
||||
import {PathEvent} from './path-events.ts';
|
||||
import {md5} from './string';
|
||||
|
||||
/**
|
||||
* Escape any regex special characters to avoid misinterpretation during search
|
||||
*
|
||||
* @param {string} value String which should be escaped
|
||||
* @return {string} New escaped sequence
|
||||
*/
|
||||
export function escapeRegex(value: string) {
|
||||
return value.replace(/[.*+?^${}()|\[\]\\]/g, '\\$&');
|
||||
}
|
||||
|
||||
/**
|
||||
* Run a stringified function with arguments asynchronously
|
||||
* @param {object} args Map of key/value arguments
|
||||
@ -26,13 +36,15 @@ export function gravatar(email: string, def='mp') {
|
||||
}
|
||||
|
||||
/**
|
||||
* Escape any regex special characters to avoid misinterpretation during search
|
||||
*
|
||||
* @param {string} value String which should be escaped
|
||||
* @return {string} New escaped sequence
|
||||
* Convert IPv6 to v4 because who uses that, NAT4Life
|
||||
* @param {string} ip IPv6 address, e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334
|
||||
* @returns {string | null} IPv4 address, e.g. 172.16.58.3
|
||||
*/
|
||||
export function escapeRegex(value: string) {
|
||||
return value.replace(/[.*+?^${}()|\[\]\\]/g, '\\$&');
|
||||
export function ipV6ToV4(ip: string) {
|
||||
if(!ip) return null;
|
||||
const ipv4 = ip.split(':').splice(-1)[0];
|
||||
if(ipv4 == '1') return '127.0.0.1';
|
||||
return ipv4;
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -48,7 +48,7 @@ export function PES(str: TemplateStringsArray, ...args: any[]) {
|
||||
if(str[i]) combined.push(str[i]);
|
||||
if(args[i]) combined.push(args[i]);
|
||||
}
|
||||
const [paths, methods] = combined.join('').split(':');
|
||||
const [paths, methods] = combined.join('/').split(':');
|
||||
return PathEvent.toString(paths, <any>methods?.split(''));
|
||||
}
|
||||
|
||||
@ -99,7 +99,7 @@ export class PathEvent {
|
||||
method = '*';
|
||||
}
|
||||
let temp = p.split('/').filter(p => !!p);
|
||||
this.module = temp.splice(0, 1)[0]?.toLowerCase() || '';
|
||||
this.module = temp.splice(0, 1)[0] || '';
|
||||
this.path = temp.join('/');
|
||||
this.fullPath = `${this.module}${this.module && this.path ? '/' : ''}${this.path}`;
|
||||
this.name = temp.pop() || '';
|
||||
@ -140,13 +140,10 @@ export class PathEvent {
|
||||
*/
|
||||
static filter(target: string | PathEvent | (string | PathEvent)[], ...filter: (string | PathEvent)[]): PathEvent[] {
|
||||
const parsedTarget = makeArray(target).map(pe => new PathEvent(pe));
|
||||
const parsedFind = makeArray(filter).map(pe => new PathEvent(pe));
|
||||
return parsedTarget.filter(t => {
|
||||
if(!t.fullPath && t.all) return true;
|
||||
return !!parsedFind.find(f =>
|
||||
(t.fullPath.startsWith(f.fullPath) || f.fullPath.startsWith(t.fullPath)) &&
|
||||
(f.all || t.all || t.methods.intersection(f.methods).length));
|
||||
});
|
||||
const parsedFilter = makeArray(filter).map(pe => new PathEvent(pe));
|
||||
return parsedTarget.filter(t => !!parsedFilter.find(f =>
|
||||
(t.fullPath == '*' || f.fullPath == '*' || t.fullPath.startsWith(f.fullPath) || f.fullPath.startsWith(t.fullPath)) &&
|
||||
(f.all || t.all || t.methods.intersection(f.methods).length)));
|
||||
}
|
||||
|
||||
/**
|
||||
@ -157,15 +154,12 @@ export class PathEvent {
|
||||
* @return {boolean} Whether there is any overlap
|
||||
*/
|
||||
static has(target: string | PathEvent | (string | PathEvent)[], ...has: (string | PathEvent)[]): boolean {
|
||||
const parsedRequired = makeArray(has).map(pe => new PathEvent(pe));
|
||||
const parsedTarget = makeArray(target).map(pe => new PathEvent(pe));
|
||||
return !!parsedRequired.find(r => {
|
||||
if(!r.fullPath && r.all) return true;
|
||||
const filtered = parsedTarget.filter(p => r.fullPath.startsWith(p.fullPath));
|
||||
if(!filtered.length) return false;
|
||||
const combined = PathEvent.combine(...filtered);
|
||||
return (!combined.none && (combined.all || r.all)) || combined.methods.intersection(r.methods).length;
|
||||
});
|
||||
const parsedRequired = makeArray(has).map(pe => new PathEvent(pe));
|
||||
return !!parsedRequired.find(r => !!parsedTarget.find(t =>
|
||||
(r.fullPath == '*' || t.fullPath == '*' || r.fullPath.startsWith(t.fullPath)) &&
|
||||
(r.all || t.all || r.methods.intersection(t.methods).length)
|
||||
));
|
||||
}
|
||||
|
||||
/**
|
||||
@ -254,8 +248,8 @@ export class PathEventEmitter implements IPathEventEmitter{
|
||||
constructor(public readonly prefix: string = '') { }
|
||||
|
||||
emit(event: Event, ...args: any[]) {
|
||||
const parsed = new PathEvent(`${this.prefix}/${new PathEvent(event).toString()}`);
|
||||
this.listeners.filter(l => PathEvent.has(l[0], `${this.prefix}/${event}`))
|
||||
const parsed = PE`${this.prefix}/${event}`;
|
||||
this.listeners.filter(l => PathEvent.has(l[0], parsed))
|
||||
.forEach(async l => l[1](parsed, ...args));
|
||||
};
|
||||
|
||||
@ -265,7 +259,7 @@ export class PathEventEmitter implements IPathEventEmitter{
|
||||
|
||||
on(event: Event | Event[], listener: PathListener): PathUnsubscribe {
|
||||
makeArray(event).forEach(e => this.listeners.push([
|
||||
new PathEvent(`${this.prefix}/${new PathEvent(e).toString()}`),
|
||||
new PathEvent(`${this.prefix}/${e}`),
|
||||
listener
|
||||
]));
|
||||
return () => this.off(listener);
|
||||
|
32
src/time.ts
32
src/time.ts
@ -190,3 +190,35 @@ export async function sleepWhile(fn : () => boolean | Promise<boolean>, checkInt
|
||||
export function timeUntil(date: Date | number): number {
|
||||
return (date instanceof Date ? date.getTime() : date) - (new Date()).getTime();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Convert a timezone string (e.g., "America/Toronto") to its current UTC offset in minutes.
|
||||
* @param {string} tz - Timezone string, e.g. "America/Toronto"
|
||||
* @param {Date} [date=new Date()] - The date for which you want the offset (default is now)
|
||||
* @returns {number} - Offset in minutes (e.g., -240)
|
||||
*/
|
||||
export function timezoneOffset(tz: string, date: Date = new Date()): number {
|
||||
const dtf = new Intl.DateTimeFormat('en-US', {
|
||||
timeZone: tz,
|
||||
hour12: false,
|
||||
year: 'numeric',
|
||||
month: '2-digit',
|
||||
day: '2-digit',
|
||||
hour: '2-digit',
|
||||
minute: '2-digit',
|
||||
second: '2-digit',
|
||||
});
|
||||
const parts = dtf.formatToParts(date);
|
||||
const get = (type: string) => Number(parts.find(v => v.type === type)?.value);
|
||||
const y = get('year');
|
||||
const mo = get('month');
|
||||
const d = get('day');
|
||||
const h = get('hour');
|
||||
const m = get('minute');
|
||||
const s = get('second');
|
||||
|
||||
const asUTC = Date.UTC(y, mo - 1, d, h, m, s);
|
||||
const asLocal = date.getTime();
|
||||
return Math.round((asLocal - asUTC) / 60000);
|
||||
}
|
||||
|
@ -27,7 +27,7 @@ describe('Path Events', () => {
|
||||
|
||||
describe('PathEvent', () => {
|
||||
it('parses event string', () => {
|
||||
const pe = new PathEvent('Users/system:cr');
|
||||
const pe = new PathEvent('users/system:cr');
|
||||
expect(pe.module).toBe('users');
|
||||
expect(pe.fullPath).toBe('users/system');
|
||||
expect(pe.name).toBe('system');
|
||||
@ -103,11 +103,9 @@ describe('Path Events', () => {
|
||||
});
|
||||
|
||||
it('has returns true for overlapping', () => {
|
||||
const events = [
|
||||
new PathEvent('users/sys:cr'),
|
||||
];
|
||||
expect(PathEvent.has(events, 'users/sys:r')).toBe(true);
|
||||
expect(PathEvent.has(events, 'users/nope:r')).toBe(false);
|
||||
const events = [new PathEvent('users/sys:cr')];
|
||||
expect(PathEvent.has(events, 'users/sys:r')).toBeTruthy();
|
||||
expect(PathEvent.has(events, 'users/nope:r')).toBeFalsy();
|
||||
});
|
||||
|
||||
it('hasAll returns true only if all overlap', () => {
|
||||
|
Loading…
x
Reference in New Issue
Block a user