Compare commits

..

42 Commits

Author SHA1 Message Date
fcae9e107e Better applyDeltas
Some checks failed
Build / Build NPM Project (push) Successful in 42s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 9s
2025-08-01 23:43:43 -04:00
5bb5067abc Better applyDeltas
Some checks failed
Build / Build NPM Project (push) Successful in 39s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 9s
2025-08-01 23:33:10 -04:00
2064880673 Fixed package version
Some checks failed
Build / Build NPM Project (push) Successful in 40s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 8s
2025-08-01 23:10:16 -04:00
fdefdf354d New delta functions
Some checks failed
Build / Build NPM Project (push) Successful in 40s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Failing after 7s
2025-08-01 22:25:50 -04:00
31998c01d6 formatDate fixed
Some checks failed
Build / Build NPM Project (push) Successful in 1m12s
Build / Tag Version (push) Successful in 16s
Build / Publish Documentation (push) Failing after 16s
2025-08-01 11:06:07 -04:00
c5270fbd7e Better date format
Some checks failed
Build / Build NPM Project (push) Failing after 46s
Build / Publish Documentation (push) Has been skipped
Build / Tag Version (push) Has been skipped
2025-08-01 09:54:22 -04:00
bfe9493d23 Added array support to delta calculations
Some checks failed
Build / Build NPM Project (push) Successful in 42s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 9s
2025-07-30 21:14:02 -04:00
1b6fe42f78 Added delta functions
Some checks failed
Build / Build NPM Project (push) Successful in 42s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 8s
2025-07-30 14:34:59 -04:00
c3d8d75ba3 Added delta functions
Some checks failed
Build / Build NPM Project (push) Successful in 41s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 9s
2025-07-30 14:22:40 -04:00
e2d756fe28 Compare version function
Some checks failed
Build / Build NPM Project (push) Successful in 54s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 9s
2025-07-30 09:21:46 -04:00
52f64f9e78 IndexDB fixes
Some checks failed
Build / Build NPM Project (push) Successful in 45s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 8s
2025-07-28 13:09:31 -04:00
4caf0e5048 IndexDB safari fixes
Some checks failed
Build / Build NPM Project (push) Successful in 54s
Build / Publish Documentation (push) Failing after 7s
Build / Tag Version (push) Successful in 10s
2025-07-28 12:52:22 -04:00
55b871f4c1 Fixed cache loading promise when persistence storage is off
Some checks failed
Build / Build NPM Project (push) Successful in 54s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 8s
2025-07-26 11:24:04 -04:00
fb077775b6 Added format milliseconds method
Some checks failed
Build / Build NPM Project (push) Successful in 42s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 8s
2025-07-25 19:51:06 -04:00
2d2b2b8216 Added format milliseconds method
Some checks failed
Build / Build NPM Project (push) Successful in 41s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 8s
2025-07-25 19:46:21 -04:00
b473ade178 Added format milliseconds method
Some checks failed
Build / Build NPM Project (push) Successful in 58s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 8s
2025-07-25 19:42:01 -04:00
b3223661dd More efficient regex
Some checks failed
Build / Build NPM Project (push) Successful in 44s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 8s
2025-07-22 14:22:47 -04:00
c36af83918 Added search transform
Some checks failed
Build / Build NPM Project (push) Successful in 43s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 9s
2025-07-22 14:16:18 -04:00
9ec70430a5 Updated include/exclude search operands
Some checks failed
Build / Build NPM Project (push) Successful in 56s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 8s
2025-07-22 13:53:10 -04:00
397b165e55 Better search include/excludes
Some checks failed
Build / Build NPM Project (push) Successful in 43s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 8s
2025-07-21 19:11:16 -04:00
c1577c2106 Better search include/excludes
Some checks failed
Build / Build NPM Project (push) Successful in 43s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 8s
2025-07-21 18:46:27 -04:00
2b12916246 Handle more reservedIP cases
Some checks failed
Build / Build NPM Project (push) Successful in 42s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 8s
2025-07-21 18:45:11 -04:00
5efb045f22 Search include/exclude null fix
Some checks failed
Build / Build NPM Project (push) Successful in 45s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 9s
2025-07-21 18:33:15 -04:00
7119390681 Added reserved IP utility
Some checks failed
Build / Build NPM Project (push) Successful in 1m4s
Build / Publish Documentation (push) Failing after 1m2s
Build / Tag Version (push) Successful in 1m11s
2025-07-21 18:25:14 -04:00
fd95c0c697 Added includes / excludes to search
Some checks failed
Build / Build NPM Project (push) Successful in 1m4s
Build / Publish Documentation (push) Failing after 15s
Build / Tag Version (push) Successful in 23s
2025-07-21 18:15:21 -04:00
1ab8e6424b handle cache cleanup in db
Some checks failed
Build / Build NPM Project (push) Successful in 40s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 8s
2025-07-14 01:00:34 -04:00
035a1d35cb PathEventEmitter handles wildcards while prefixed
Some checks failed
Build / Build NPM Project (push) Successful in 52s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 8s
2025-07-14 00:31:11 -04:00
e78120b067 Trying to do a better job of detecting persistent caching strategy
Some checks failed
Build / Build NPM Project (push) Successful in 51s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 8s
2025-07-08 01:46:06 -04:00
71552aa243 Fixed cache save to db
Some checks failed
Build / Build NPM Project (push) Successful in 43s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 8s
2025-07-07 15:27:07 -04:00
ce3878e18b Added db safe guards
Some checks failed
Build / Build NPM Project (push) Successful in 44s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 9s
2025-07-07 14:53:14 -04:00
388a09718b Reverted ASet
Some checks failed
Build / Build NPM Project (push) Successful in 43s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 8s
2025-07-07 14:34:29 -04:00
59bce9d28d Optimizations
Some checks failed
Build / Build NPM Project (push) Failing after 29s
Build / Publish Documentation (push) Has been skipped
Build / Tag Version (push) Has been skipped
2025-07-07 14:29:49 -04:00
387e6b2512 Fixed cache save to db
Some checks failed
Build / Build NPM Project (push) Successful in 43s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 8s
2025-07-07 12:41:44 -04:00
d748d740ea bump 0.26.0
Some checks failed
Build / Build NPM Project (push) Successful in 42s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 8s
2025-07-07 10:52:36 -04:00
c8f44584a2 Fixed cache saving with different backends
Some checks failed
Build / Build NPM Project (push) Successful in 43s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 8s
2025-07-07 10:46:54 -04:00
8b84d170a6 Fixed test
Some checks failed
Build / Build NPM Project (push) Successful in 1m11s
Build / Tag Version (push) Successful in 17s
Build / Publish Documentation (push) Failing after 19s
2025-07-07 10:42:40 -04:00
37df7e6090 Fixed an unreliable caching backend check
Some checks failed
Build / Build NPM Project (push) Failing after 45s
Build / Publish Documentation (push) Has been skipped
Build / Tag Version (push) Has been skipped
2025-07-07 10:36:47 -04:00
a8b6fdd5a6 fixed type error in test
Some checks failed
Build / Build NPM Project (push) Successful in 40s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 9s
2025-07-06 22:19:45 -04:00
3e899e6ae4 Clear cache DB correctly
Some checks failed
Build / Build NPM Project (push) Successful in 1m24s
Build / Tag Version (push) Successful in 19s
Build / Publish Documentation (push) Failing after 17s
2025-07-06 20:41:01 -04:00
08fa5b6783 Clear cache DB correctly
Some checks failed
Build / Build NPM Project (push) Successful in 42s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 8s
2025-07-04 01:23:57 -04:00
529f1e2b30 fixed docs submodule
Some checks failed
Build / Build NPM Project (push) Successful in 1m10s
Build / Tag Version (push) Successful in 15s
Build / Publish Documentation (push) Failing after 5s
2025-07-04 00:39:22 -04:00
87ef246760 Indexdb race conditions
Some checks failed
Build / Build NPM Project (push) Failing after 6s
Build / Publish Documentation (push) Has been skipped
Build / Tag Version (push) Has been skipped
2025-07-04 00:34:31 -04:00
17 changed files with 580 additions and 262 deletions

2
.gitmodules vendored
View File

@ -1,5 +1,5 @@
[submodule "docs"] [submodule "docs"]
path = docs path = docs
url = git@git.zakscode.com:ztimson/utils.wiki.git url = ../utils.wiki.git
branch = master branch = master
ignore = all ignore = all

View File

@ -1,9 +1,11 @@
<html> <html>
<body> <body>
<script type="module"> <script type="module">
import {PES} from './dist/index.mjs'; import {formatDate} from './dist/index.mjs';
console.log(PES`storage${'Test/Test'}:d`); const dt = new Date('2021-03-03T09:00:00Z');
const result = formatDate('Do MMMM dddd', dt, 0);
console.log(result);
</script> </script>
</body> </body>
</html> </html>

View File

@ -1,6 +1,6 @@
{ {
"name": "@ztimson/utils", "name": "@ztimson/utils",
"version": "0.25.23", "version": "0.27.3",
"description": "Utility library", "description": "Utility library",
"author": "Zak Timson", "author": "Zak Timson",
"license": "MIT", "license": "MIT",

View File

@ -1,13 +1,11 @@
import {Table} from './database.ts'; import {Database, Table} from './database.ts';
import {deepCopy, includes, JSONSanitize} from './objects.ts'; import {deepCopy, includes, 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 | Table<any, any>; persistentStorage?: {storage: Storage | Database, key: string} | string;
/** Key cache will be stored under */
storageKey?: string;
/** Keep or delete cached items once expired, defaults to delete */ /** Keep or delete cached items once expired, defaults to delete */
expiryPolicy?: 'delete' | 'keep'; expiryPolicy?: 'delete' | 'keep';
} }
@ -24,8 +22,10 @@ export class Cache<K extends string | number | symbol, T> {
[key: string | number | symbol]: CachedValue<T> | any; [key: string | number | symbol]: CachedValue<T> | any;
/** Whether cache is complete */ /** Whether cache is complete */
complete = false; complete = false;
private _loading!: Function;
/** Await initial loading */ /** Await initial loading */
loading!: Promise<void>; loading = new Promise<void>(r => this._loading = r);
/** /**
* Create new cache * Create new cache
@ -33,21 +33,29 @@ 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 = {}) {
let resolve: any; // Persistent storage
this.loading = new Promise(r => resolve = r); if(this.options.persistentStorage != null) {
if(options.storageKey && !options.storage && typeof(Storage) !== 'undefined') options.storage = localStorage; if(typeof this.options.persistentStorage == 'string')
if(options.storage) { this.options.persistentStorage = {storage: localStorage, key: this.options.persistentStorage};
if(options.storage instanceof Table) {
if(this.options.persistentStorage?.storage?.database != undefined) {
(async () => { (async () => {
this.addAll(await options.storage?.getAll(), false); const persists: any = this.options.persistentStorage;
resolve(); const table: Table<any, any> = await persists.storage.createTable({name: persists.key, key: this.key});
})() const rows = await table.getAll();
} else if(options.storageKey) { Object.assign(this.store, rows.reduce((acc, row) => ({...acc, [this.getKey(row)]: row}), {}));
const stored = options.storage?.getItem(options.storageKey); this._loading();
})();
} else if((<any>this.options.persistentStorage?.storage)?.getItem != undefined) {
const stored = (<Storage>this.options.persistentStorage.storage).getItem(this.options.persistentStorage.key);
if(stored != null) try { Object.assign(this.store, JSON.parse(stored)); } catch { } if(stored != null) try { Object.assign(this.store, JSON.parse(stored)); } catch { }
resolve(); this._loading();
} }
} else resolve(); } else {
this._loading();
}
// Handle index lookups
return new Proxy(this, { return new Proxy(this, {
get: (target: this, prop: string | symbol) => { get: (target: this, prop: string | symbol) => {
if(prop in target) return (target as any)[prop]; if(prop in target) return (target as any)[prop];
@ -68,19 +76,21 @@ export class Cache<K extends string | number | symbol, T> {
} }
private save(key?: K) { private save(key?: K) {
if(this.options.storage) { const persists: {storage: any, key: string} = <any>this.options.persistentStorage;
if(this.options.storage instanceof Table) { if(!!persists?.storage) {
if(key == null) { if(persists.storage?.database != undefined) {
const rows = this.entries(); (<Database>persists.storage).createTable({name: persists.key, key: <string>this.key}).then(table => {
rows.forEach(([k, v]) => this.options.storage?.put(k, v)); if(key) {
this.options.storage.getAllKeys().then(keys => { const value = this.get(key);
rows.map(([k]) => k).filter(k => !keys.includes(k)) if(value != null) table.set(value, key);
.forEach(k => this.options.storage?.delete(k)); else table.delete(key);
}) } else {
} else if(this.store[key] === undefined) this.options.storage.delete(key); table.clear();
else this.options.storage.put(key, this.store[key]); this.all().forEach(row => table.add(row));
} else if(this.options.storageKey) { }
this.options.storage.setItem(this.options.storageKey, JSONSanitize(this.store)); });
} else if(persists.storage?.setItem != undefined) {
persists.storage.setItem(persists.storage.key, JSONSanitize(this.all(true)));
} }
} }
} }

View File

@ -1,5 +1,6 @@
import {findByProp} from './array.ts'; import {findByProp} from './array.ts';
import {ASet} from './aset.ts'; import {ASet} from './aset.ts';
import {sleepWhile} from './time.ts';
export type TableOptions = { export type TableOptions = {
name: string; name: string;
@ -7,14 +8,30 @@ export type TableOptions = {
autoIncrement?: boolean; autoIncrement?: boolean;
}; };
class AsyncLock {
private p = Promise.resolve();
run<T>(fn: () => Promise<T>): Promise<T> {
const res = this.p.then(fn, fn);
this.p = res.then(() => {}, () => {});
return res;
}
}
export class Database { export class Database {
private schemaLock = new AsyncLock();
private upgrading = false;
connection!: Promise<IDBDatabase>; connection!: Promise<IDBDatabase>;
ready = false;
tables!: TableOptions[]; tables!: TableOptions[];
get ready() { return !this.upgrading; }
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) => { this.connection = new Promise((resolve, reject) => {
const req = indexedDB.open(this.database, this.version); let req: IDBOpenDBRequest;
try { req = indexedDB.open(this.database, this.version); }
catch (err) { return reject(err); }
this.tables = !tables ? [] : tables.map(t => { this.tables = !tables ? [] : tables.map(t => {
t = typeof t == 'object' ? t : {name: t}; t = typeof t == 'object' ? t : {name: t};
return {...t, name: t.name.toString()}; return {...t, name: t.name.toString()};
@ -23,13 +40,22 @@ export class Database {
req.onerror = () => reject(req.error); req.onerror = () => reject(req.error);
req.onsuccess = () => { req.onsuccess = () => {
const db = req.result; let db: IDBDatabase;
try { db = req.result; }
catch (err) { return reject(err); }
const existing = Array.from(db.objectStoreNames); const existing = Array.from(db.objectStoreNames);
if(!tables) this.tables = existing.map(t => { if(!tables) {
const tx = db.transaction(t, 'readonly', ) this.tables = existing.map(t => {
const store = tx.objectStore(t); try {
return {name: t, key: <string>store.keyPath}; const tx = db.transaction(t, 'readonly');
}); const store = tx.objectStore(t);
return {name: t, key: <string>store.keyPath};
} catch {
return {name: t}; // 🛡️ fallback
}
});
}
const desired = new ASet((tables || []).map(t => typeof t == 'string' ? t : t.name)); const desired = new ASet((tables || []).map(t => typeof t == 'string' ? t : t.name));
if(tables && desired.symmetricDifference(new ASet(existing)).length) { if(tables && desired.symmetricDifference(new ASet(existing)).length) {
db.close(); db.close();
@ -39,43 +65,60 @@ export class Database {
this.version = db.version; this.version = db.version;
resolve(db); resolve(db);
} }
this.ready = true; this.upgrading = false;
}; };
req.onupgradeneeded = () => { req.onupgradeneeded = () => {
const db = req.result; this.upgrading = true;
const existingTables = new ASet(Array.from(db.objectStoreNames)); let db: IDBDatabase;
if(tables) { try { db = req.result; }
const desired = new ASet((tables || []).map(t => typeof t == 'string' ? t : t.name)); catch { return; }
existingTables.difference(desired).forEach(name => db.deleteObjectStore(name)); try {
desired.difference(existingTables).forEach(name => { const existingTables = new ASet(Array.from(db.objectStoreNames));
const t = this.tables.find(findByProp('name', name)); if(tables) {
db.createObjectStore(name, { const desired = new ASet((tables || []).map(t => typeof t == 'string' ? t : t.name));
keyPath: t?.key, existingTables.difference(desired).forEach(name => db.deleteObjectStore(name));
autoIncrement: t?.autoIncrement || !t?.key desired.difference(existingTables).forEach(name => {
const t = this.tables.find(findByProp('name', name));
db.createObjectStore(name, {
keyPath: t?.key,
autoIncrement: t?.autoIncrement || !t?.key,
});
}); });
}); }
} } catch { }
}; };
}); });
} }
waitForUpgrade = () => sleepWhile(() => this.upgrading);
async createTable<K extends IDBValidKey = any, T = any>(table: string | TableOptions): Promise<Table<K, T>> { async createTable<K extends IDBValidKey = any, T = any>(table: string | TableOptions): Promise<Table<K, T>> {
if(typeof table == 'string') table = {name: table}; return this.schemaLock.run(async () => {
const conn = await this.connection; if(typeof table == 'string') table = { name: table };
if(!this.includes(table.name)) { const conn = await this.connection;
conn.close(); if(!this.includes(table.name)) {
Object.assign(this, new Database(this.database, [...this.tables, table], (this.version ?? 0) + 1)); const newDb = new Database(this.database, [...this.tables, table], (this.version ?? 0) + 1);
} conn.close();
return this.table<K, T>(table.name); this.connection = newDb.connection;
await this.connection;
Object.assign(this, newDb);
}
return this.table<K, T>(table.name);
});
} }
async deleteTable(table: string | TableOptions): Promise<void> { async deleteTable(table: string | TableOptions): Promise<void> {
if(typeof table == 'string') table = {name: table}; return this.schemaLock.run(async () => {
if(!this.includes(table.name)) return; if(typeof table == 'string') table = { name: table };
const conn = await this.connection; if(!this.includes(table.name)) return;
conn.close(); const conn = await this.connection;
Object.assign(this, new Database(this.database, this.tables.filter(t => t.name != table.name), (this.version ?? 0) + 1)); const newDb = new Database(this.database, this.tables.filter(t => t.name != (<TableOptions>table).name), (this.version ?? 0) + 1);
conn.close();
this.connection = newDb.connection;
await this.connection;
Object.assign(this, newDb);
});
} }
includes(name: any): boolean { includes(name: any): boolean {
@ -96,12 +139,12 @@ export class Table<K extends IDBValidKey = any, T = any> {
} }
async tx<R>(table: string, fn: (store: IDBObjectStore) => IDBRequest, readonly = false): Promise<R> { async tx<R>(table: string, fn: (store: IDBObjectStore) => IDBRequest, readonly = false): Promise<R> {
await this.database.waitForUpgrade();
const db = await this.database.connection; const db = await this.database.connection;
const tx = db.transaction(table, readonly ? 'readonly' : 'readwrite'); const tx = db.transaction(table, readonly ? 'readonly' : 'readwrite');
const store = tx.objectStore(table);
return new Promise<R>((resolve, reject) => { return new Promise<R>((resolve, reject) => {
const request = fn(store); const request = fn(tx.objectStore(table));
request.onsuccess = () => resolve(request.result as R); // ✅ explicit cast request.onsuccess = () => resolve(request.result as R);
request.onerror = () => reject(request.error); request.onerror = () => reject(request.error);
}); });
} }
@ -138,8 +181,11 @@ export class Table<K extends IDBValidKey = any, T = any> {
return this.tx(this.name, store => store.getAllKeys(), true); return this.tx(this.name, store => store.getAllKeys(), true);
} }
put(key: K, value: T): Promise<void> { put(value: T, key?: string): Promise<void> {
return this.tx(this.name, store => store.put(value, key)); return this.tx(this.name, store => {
if(store.keyPath) return store.put(value);
return store.put(value, key);
});
} }
read(): Promise<T[]>; read(): Promise<T[]>;
@ -149,8 +195,9 @@ export class Table<K extends IDBValidKey = any, T = any> {
} }
set(value: T, key?: K): Promise<void> { set(value: T, key?: K): Promise<void> {
if(!key && !(<any>value)[this.key]) return this.add(value); if(key) (<any>value)[this.key] = key;
return this.put(key || (<any>value)[this.key], value); if(!(<any>value)[this.key]) return this.add(value);
return this.put(value);
} }
update = this.set; update = this.set;

View File

@ -78,7 +78,7 @@ export class Http {
if(!this.url && !opts.url) throw new Error('URL needs to be set'); if(!this.url && !opts.url) throw new Error('URL needs to be set');
let url = opts.url?.startsWith('http') ? opts.url : (this.url || '') + (opts.url || ''); let url = opts.url?.startsWith('http') ? opts.url : (this.url || '') + (opts.url || '');
url = url.replaceAll(/([^:]\/)\/+/g, '$1'); url = url.replaceAll(/([^:]\/)\/+/g, '$1');
if(opts.fragment) url.includes('#') ? url.replace(/#.*(\?|\n)/g, (match, arg1) => `#${opts.fragment}${arg1}`) : `${url}#${opts.fragment}`; if(opts.fragment) url.includes('#') ? url.replace(/#.*([?\n])/g, (match, arg1) => `#${opts.fragment}${arg1}`) : `${url}#${opts.fragment}`;
if(opts.query) { if(opts.query) {
const q = Array.isArray(opts.query) ? opts.query : const q = Array.isArray(opts.query) ? opts.query :
Object.keys(opts.query).map(k => ({key: k, value: (<any>opts.query)[k]})) Object.keys(opts.query).map(k => ({key: k, value: (<any>opts.query)[k]}))

View File

@ -48,3 +48,17 @@ export function fracToDec(frac: string) {
split = (<string>split.pop()).split('/'); split = (<string>split.pop()).split('/');
return whole + (Number(split[0]) / Number(split[1])); return whole + (Number(split[0]) / Number(split[1]));
} }
/**
* Add a suffix to a number:
* 1 = 1st
* 2 = 2nd
* 3 = 3rd
* N = Nth
* @param {number} n
* @returns {string}
*/
export function numSuffix(n: number): string {
const s = ['th', 'st', 'nd', 'rd'], v = n % 100;
return `${n}${s[(v - 20) % 10] || s[v] || s[0]}`;
}

View File

@ -1,9 +1,21 @@
import {PathEvent} from './path-events.ts'; import {PathEvent} from './path-events.ts';
import {md5} from './string'; import {md5} from './string';
/**
* Compare version numbers
* @param {string} target
* @param {string} vs
* @return {number} -1 = target is lower, 0 = equal, 1 = higher
*/
export function compareVersions(target: string, vs: string): -1 | 0 | 1 {
const [tMajor, tMinor, tPatch] = target.split('.').map(v => +v.replace(/[^0-9]/g, ''));
const [vMajor, vMinor, vPatch] = vs.split('.').map(v => +v.replace(/[^0-9]/g, ''));
return (tMajor > vMajor || tMinor > vMinor || tPatch > vPatch) ? 1 :
(tMajor < vMajor || tMinor < vMinor || tPatch < vPatch) ? -1 : 0;
}
/** /**
* Escape any regex special characters to avoid misinterpretation during search * Escape any regex special characters to avoid misinterpretation during search
*
* @param {string} value String which should be escaped * @param {string} value String which should be escaped
* @return {string} New escaped sequence * @return {string} New escaped sequence
*/ */
@ -47,6 +59,17 @@ export function ipV6ToV4(ip: string) {
return ipv4; return ipv4;
} }
/**
* Check if IP is reserved, e.g. localhost, private IPs, etc.
* @param {string} ip
* @returns {boolean}
*/
export function reservedIp(ip: string): boolean {
if(ip == 'localhost' || ip == '127.0.0.1') return true;
return /\b(10\.(?:[0-9]{1,3}\.){2}[0-9]{1,3})\b|\b(172\.(?:1[6-9]|2[0-9]|3[0-1])\.(?:[0-9]{1,3}\.)[0-9]{1,3})\b|\b(192\.168\.(?:[0-9]{1,3}\.)[0-9]{1,3})\b/.test(ip);
}
/** /**
* Represents a function that listens for events and handles them accordingly. * Represents a function that listens for events and handles them accordingly.
* *

View File

@ -1,3 +1,53 @@
export type Delta = { [key: string]: any | Delta | null };
/**
* Applies deltas to `target`.
* @param base starting point
* @param deltas List of deltas to apply
* @returns Mutated target
*/
export function applyDeltas(base: any, ...deltas: any[]): any {
function applyDelta(base: any, delta: any): any {
if(delta === null) return null;
if(typeof base !== 'object' || base === null) return delta === undefined ? base : delta;
const result = Array.isArray(base) ? [...base] : { ...base };
for(const key in delta) {
const val = delta[key];
if(val === undefined) delete result[key];
else if(typeof val === 'object' && val !== null && !Array.isArray(val)) result[key] = applyDelta(result[key], val);
else result[key] = val;
}
return result;
}
for(const d of deltas.flat()) base = applyDelta(base, d?.delta ?? d);
return base;
}
/**
* Creates a nested delta that reverts `target` back to `old`.
* @param old - Original object
* @param updated - Modified object
* @returns New changes
*/
export function calcDelta(old: any, updated: any): any {
if(updated == null) return null; // full delete
const delta: any = {};
const isObj = (v: any) => v && typeof v === 'object' && !Array.isArray(v);
for (const key of new Set([...(old ? Object.keys(old) : []), ...(updated ? Object.keys(updated) : [])])) {
const oldVal = old?.[key];
const newVal = updated?.[key];
if(isObj(oldVal) && isObj(newVal)) {
const nested = calcDelta(oldVal, newVal);
if(nested !== null && Object.keys(nested).length > 0) delta[key] = nested;
} else if(JSON.stringify(oldVal) !== JSON.stringify(newVal)) {
delta[key] = newVal;
}
}
return Object.keys(delta).length === 0 ? {} : delta;
}
/** /**
* Removes any null values from an object in-place * Removes any null values from an object in-place
* *
@ -177,19 +227,51 @@ export function includes(target: any, values: any, allowMissing = false): boolea
} }
/** /**
* Deep check if two objects are equal * Deep check if two items are equal.
* Handles primitives, objects, arrays, functions, Date, RegExp, and circular references.
* *
* @param {any} a - first item to compare * @param {any} a - first item to compare
* @param {any} b - second item to compare * @param {any} b - second item to compare
* @param {WeakMap<object, object>} [seen] - Internal parameter to track circular references
* @returns {boolean} True if they match * @returns {boolean} True if they match
*/ */
export function isEqual(a: any, b: any): boolean { export function isEqual(a: any, b: any, seen = new WeakMap<object, object>()): boolean {
const ta = typeof a, tb = typeof b; // Simple cases
if((ta != 'object' || a == null) || (tb != 'object' || b == null)) if(a === b) return true;
return ta == 'function' && tb == 'function' ? a.toString() == b.toString() : a === b; if(a instanceof Date && b instanceof Date) return a.getTime() === b.getTime();
const keys = Object.keys(a); if(a instanceof RegExp && b instanceof RegExp) return a.source === b.source && a.flags === b.flags;
if(keys.length != Object.keys(b).length) return false;
return Object.keys(a).every(key => isEqual(a[key], b[key])); // Null checks
if(typeof a !== 'object' || a === null || typeof b !== 'object' || b === null) {
if(Number.isNaN(a) && Number.isNaN(b)) return true;
if(typeof a === 'function' && typeof b === 'function') return a.toString() === b.toString()
return false;
}
// Circular references
if(seen.has(a)) return seen.get(a) === b;
seen.set(a, b);
const isArrayA = Array.isArray(a);
const isArrayB = Array.isArray(b);
// Array checks
if(isArrayA && isArrayB) {
if(a.length !== b.length) return false;
for(let i = 0; i < a.length; i++) {
if(!isEqual(a[i], b[i], seen)) return false;
}
return true;
}
if(isArrayA !== isArrayB) return false;
// Key & value deep comparison
const keysA = Object.keys(a);
const keysB = Object.keys(b);
if(keysA.length !== keysB.length) return false;
for(const key of keysA) {
if(!Object.prototype.hasOwnProperty.call(b, key) || !isEqual(a[key], b[key], seen)) return false;
}
return true;
} }
/** /**
@ -243,8 +325,8 @@ export function JSONSerialize<T1>(obj: T1): T1 | string {
export function JSONSanitize(obj: any, space?: number): string { export function JSONSanitize(obj: any, space?: number): string {
const cache: any[] = []; const cache: any[] = [];
return JSON.stringify(obj, (key, value) => { return JSON.stringify(obj, (key, value) => {
if (typeof value === 'object' && value !== null) { if(typeof value === 'object' && value !== null) {
if (cache.includes(value)) return '[Circular]'; if(cache.includes(value)) return '[Circular]';
cache.push(value); cache.push(value);
} }
return value; return value;

View File

@ -71,9 +71,12 @@ export class PathEvent {
/** List of methods */ /** List of methods */
methods!: ASet<Method>; methods!: ASet<Method>;
/** Internal cache for PathEvent instances to avoid redundant parsing */
private static pathEventCache: Map<string, PathEvent> = new Map();
/** All/Wildcard specified */ /** All/Wildcard specified */
get all(): boolean { return this.methods.has('*') } get all(): boolean { return this.methods.has('*') }
set all(v: boolean) { v ? new ASet<Method>(['*']) : this.methods.delete('*'); } set all(v: boolean) { v ? this.methods = new ASet<Method>(['*']) : this.methods.delete('*'); }
/** None specified */ /** None specified */
get none(): boolean { return this.methods.has('n') } get none(): boolean { return this.methods.has('n') }
set none(v: boolean) { v ? this.methods = new ASet<Method>(['n']) : this.methods.delete('n'); } set none(v: boolean) { v ? this.methods = new ASet<Method>(['n']) : this.methods.delete('n'); }
@ -91,10 +94,20 @@ export class PathEvent {
set delete(v: boolean) { v ? this.methods.delete('n').delete('*').add('d') : this.methods.delete('d'); } set delete(v: boolean) { v ? this.methods.delete('n').delete('*').add('d') : this.methods.delete('d'); }
constructor(e: string | PathEvent) { constructor(e: string | PathEvent) {
if(typeof e == 'object') return Object.assign(this, e); if(typeof e == 'object') {
Object.assign(this, e);
return;
}
// Check cache first
if (PathEvent.pathEventCache.has(e)) {
Object.assign(this, PathEvent.pathEventCache.get(e)!);
return;
}
let [p, scope, method] = e.replaceAll(/\/{2,}/g, '/').split(':'); let [p, scope, method] = e.replaceAll(/\/{2,}/g, '/').split(':');
if(!method) method = scope || '*'; if(!method) method = scope || '*';
if(p == '*' || !p && method == '*') { if(p == '*' || (!p && method == '*')) {
p = ''; p = '';
method = '*'; method = '*';
} }
@ -104,6 +117,14 @@ export class PathEvent {
this.fullPath = `${this.module}${this.module && this.path ? '/' : ''}${this.path}`; this.fullPath = `${this.module}${this.module && this.path ? '/' : ''}${this.path}`;
this.name = temp.pop() || ''; this.name = temp.pop() || '';
this.methods = new ASet(<any>method.split('')); this.methods = new ASet(<any>method.split(''));
// Store in cache
PathEvent.pathEventCache.set(e, this);
}
/** Clear the cache of all PathEvents */
static clearCache(): void {
PathEvent.pathEventCache.clear();
} }
/** /**
@ -115,7 +136,7 @@ export class PathEvent {
*/ */
static combine(...paths: (string | PathEvent)[]): PathEvent { static combine(...paths: (string | PathEvent)[]): PathEvent {
let hitNone = false; let hitNone = false;
const combined = paths.map(p => new PathEvent(p)) const combined = paths.map(p => p instanceof PathEvent ? p : new PathEvent(p))
.toSorted((p1, p2) => { .toSorted((p1, p2) => {
const l1 = p1.fullPath.length, l2 = p2.fullPath.length; const l1 = p1.fullPath.length, l2 = p2.fullPath.length;
return l1 < l2 ? 1 : (l1 > l2 ? -1 : 0); return l1 < l2 ? 1 : (l1 > l2 ? -1 : 0);
@ -124,10 +145,9 @@ export class PathEvent {
if(p.none) hitNone = true; if(p.none) hitNone = true;
if(!acc) return p; if(!acc) return p;
if(hitNone) return acc; if(hitNone) return acc;
acc.methods = [...acc.methods, ...p.methods]; acc.methods = new ASet([...acc.methods, ...p.methods]);
return acc; return acc;
}, <any>null); }, <any>null);
combined.methods = new ASet<Method>(combined.methods);
return combined; return combined;
} }
@ -139,11 +159,12 @@ export class PathEvent {
* @return {boolean} Whether there is any overlap * @return {boolean} Whether there is any overlap
*/ */
static filter(target: string | PathEvent | (string | PathEvent)[], ...filter: (string | PathEvent)[]): PathEvent[] { static filter(target: string | PathEvent | (string | PathEvent)[], ...filter: (string | PathEvent)[]): PathEvent[] {
const parsedTarget = makeArray(target).map(pe => new PathEvent(pe)); const parsedTarget = makeArray(target).map(pe => pe instanceof PathEvent ? pe : new PathEvent(pe));
const parsedFilter = makeArray(filter).map(pe => new PathEvent(pe)); const parsedFilter = makeArray(filter).map(pe => pe instanceof PathEvent ? pe : new PathEvent(pe));
return parsedTarget.filter(t => !!parsedFilter.find(r => { return parsedTarget.filter(t => !!parsedFilter.find(r => {
const wildcard = r.fullPath == '*' || t.fullPath == '*'; const wildcard = r.fullPath == '*' || t.fullPath == '*';
const p1 = r.fullPath.slice(0, r.fullPath.indexOf('*')), p2 = t.fullPath.slice(0, t.fullPath.indexOf('*')) const p1 = r.fullPath.includes('*') ? r.fullPath.slice(0, r.fullPath.indexOf('*')) : r.fullPath;
const p2 = t.fullPath.includes('*') ? t.fullPath.slice(0, t.fullPath.indexOf('*')) : t.fullPath;
const scope = p1.startsWith(p2) || p2.startsWith(p1); const scope = p1.startsWith(p2) || p2.startsWith(p1);
const methods = r.all || t.all || r.methods.intersection(t.methods).length; const methods = r.all || t.all || r.methods.intersection(t.methods).length;
return (wildcard || scope) && methods; return (wildcard || scope) && methods;
@ -158,12 +179,13 @@ export class PathEvent {
* @return {boolean} Whether there is any overlap * @return {boolean} Whether there is any overlap
*/ */
static has(target: string | PathEvent | (string | PathEvent)[], ...has: (string | PathEvent)[]): boolean { static has(target: string | PathEvent | (string | PathEvent)[], ...has: (string | PathEvent)[]): boolean {
const parsedTarget = makeArray(target).map(pe => new PathEvent(pe)); const parsedTarget = makeArray(target).map(pe => pe instanceof PathEvent ? pe : new PathEvent(pe));
const parsedRequired = makeArray(has).map(pe => new PathEvent(pe)); const parsedRequired = makeArray(has).map(pe => pe instanceof PathEvent ? pe : new PathEvent(pe));
return !!parsedRequired.find(r => !!parsedTarget.find(t => { return !!parsedRequired.find(r => !!parsedTarget.find(t => {
const wildcard = r.fullPath == '*' || t.fullPath == '*'; const wildcard = r.fullPath == '*' || t.fullPath == '*';
const p1 = r.fullPath.slice(0, r.fullPath.indexOf('*')), p2 = t.fullPath.slice(0, t.fullPath.indexOf('*')) const p1 = r.fullPath.includes('*') ? r.fullPath.slice(0, r.fullPath.indexOf('*')) : r.fullPath;
const scope = p1.startsWith(p2); const p2 = t.fullPath.includes('*') ? t.fullPath.slice(0, t.fullPath.indexOf('*')) : t.fullPath;
const scope = p1.startsWith(p2); // Note: Original had || p2.startsWith(p1) here, but has implies target has required.
const methods = r.all || t.all || r.methods.intersection(t.methods).length; const methods = r.all || t.all || r.methods.intersection(t.methods).length;
return (wildcard || scope) && methods; return (wildcard || scope) && methods;
})); }));
@ -293,7 +315,7 @@ export class PathEventEmitter implements IPathEventEmitter{
constructor(public readonly prefix: string = '') { } constructor(public readonly prefix: string = '') { }
emit(event: Event, ...args: any[]) { emit(event: Event, ...args: any[]) {
const parsed = PE`${this.prefix}/${event}`; const parsed = event instanceof PathEvent ? event : new PathEvent(`${this.prefix}/${event}`);
this.listeners.filter(l => PathEvent.has(l[0], parsed)) this.listeners.filter(l => PathEvent.has(l[0], parsed))
.forEach(async l => l[1](parsed, ...args)); .forEach(async l => l[1](parsed, ...args));
}; };
@ -303,10 +325,13 @@ export class PathEventEmitter implements IPathEventEmitter{
} }
on(event: Event | Event[], listener: PathListener): PathUnsubscribe { on(event: Event | Event[], listener: PathListener): PathUnsubscribe {
makeArray(event).forEach(e => this.listeners.push([ makeArray(event).forEach(e => {
new PathEvent(`${this.prefix}/${e}`), if(typeof e == 'string' && e[0] == '*' && this.prefix) e = e.slice(1);
listener this.listeners.push([
])); e instanceof PathEvent ? e : new PathEvent(`${this.prefix}/${e}`),
listener
])
});
return () => this.off(listener); return () => this.off(listener);
} }

View File

@ -13,8 +13,8 @@ export function search(rows: any[], search: string, regex?: boolean, transform:
if(!rows) return []; if(!rows) return [];
return rows.filter(r => { return rows.filter(r => {
// Empty search // Empty search
const value = transform(r);
if(!search) return true; if(!search) return true;
const value = transform(r);
// Regex search // Regex search
if(regex) { if(regex) {
return !!Object.values(value).filter((v: any) => { return !!Object.values(value).filter((v: any) => {
@ -22,7 +22,7 @@ export function search(rows: any[], search: string, regex?: boolean, transform:
catch { return false; } catch { return false; }
}).length }).length
} else { } else {
return logicTest(r, search); return logicTest(value, search);
} }
}); });
} }
@ -39,6 +39,8 @@ export function logicTest(target: object, condition: string): boolean {
case '=': case '=':
case '==': return a == b; case '==': return a == b;
case '!=': return a != b; case '!=': return a != b;
case '+=': return a?.toString().includes(b);
case '-=': return !a?.toString().includes(b);
case '>': return a > b; case '>': return a > b;
case '>=': return a >= b; case '>=': return a >= b;
case '<': return a < b; case '<': return a < b;
@ -53,7 +55,7 @@ export function logicTest(target: object, condition: string): boolean {
const and = p.split('&&').map(p => p.trim()).filter(p => !!p); const and = p.split('&&').map(p => p.trim()).filter(p => !!p);
return and.filter(p => { return and.filter(p => {
// Boolean operator // Boolean operator
const prop = /(\S+)\s*(==?|!=|>=|>|<=|<)\s*(\S+)/g.exec(p); const prop = /(\S+)\s*(==?|!=|\+=|-=|>=|>|<=|<)\s*(\S+)/g.exec(p);
if(prop) { if(prop) {
const key = Object.keys(target).find(k => k.toLowerCase() == prop[1].toLowerCase()); const key = Object.keys(target).find(k => k.toLowerCase() == prop[1].toLowerCase());
return evalBoolean(dotNotation<any>(target, key || prop[1]), prop[2], JSONAttemptParse(prop[3])); return evalBoolean(dotNotation<any>(target, key || prop[1]), prop[2], JSONAttemptParse(prop[3]));

View File

@ -43,6 +43,24 @@ export function formatBytes(bytes: number, decimals = 2) {
return parseFloat((bytes / Math.pow(k, i)).toFixed(decimals)) + ' ' + sizes[i]; return parseFloat((bytes / Math.pow(k, i)).toFixed(decimals)) + ' ' + sizes[i];
} }
/**
* Convert milliseconds to human-readable duration
* @param {string} ms milliseconds
* @param {boolean} short Use unit initial instead of word
* @return {string} formated duration
*/
export function formatMs(ms: number, short = false): string {
if (isNaN(ms) || ms < 0) return "Invalid input";
const seconds = ms / 1000;
const minutes = seconds / 60;
const hours = minutes / 60;
const days = hours / 24;
if (days >= 1) return `${days.toFixed(1)} ${short ? 'd' : 'days'}`;
else if (hours >= 1) return `${hours.toFixed(1)} ${short ? 'h' : 'hours'}`;
else if (minutes >= 1) return `${minutes.toFixed(1)} ${short ? 'm' : 'minutes'}`;
else return `${seconds.toFixed(1)} ${short ? 's' : 'seconds'}`;
}
/** /**
* Extract numbers from a string & create a formated phone number: +1 (123) 456-7890 * Extract numbers from a string & create a formated phone number: +1 (123) 456-7890
* *

View File

@ -1,3 +1,5 @@
import {numSuffix} from './math.ts';
/** /**
* Like setInterval but will adjust the timeout value to account for runtime * Like setInterval but will adjust the timeout value to account for runtime
* @param {Function} cb Callback function that will be ran * @param {Function} cb Callback function that will be ran
@ -20,6 +22,15 @@ export function adjustedInterval(cb: Function, ms: number) {
} }
} }
export function dayOfWeek(d: number): string {
return ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'][d];
}
export function dayOfYear(date: Date): number {
const start = new Date(Date.UTC(date.getUTCFullYear(), 0, 1));
return Math.ceil((date.getTime() - start.getTime()) / (1000 * 60 * 60 * 24));
}
/** /**
* Format date * Format date
* *
@ -28,111 +39,94 @@ export function adjustedInterval(cb: Function, ms: number) {
* @param tz Set timezone offset * @param tz Set timezone offset
* @return {string} Formated date * @return {string} Formated date
*/ */
export function formatDate(format = 'YYYY-MM-DD H:mm', date: Date | number | string = new Date(), tz?: string | number): string { export function formatDate(format: string = 'YYYY-MM-DD H:mm', date: Date | number | string = new Date(), tz: string | number = 'local'): string {
const timezones = [ if (typeof date === 'number' || typeof date === 'string') date = new Date(date);
['IDLW', -12], if (isNaN(date.getTime())) throw new Error('Invalid date input');
['SST', -11], const numericTz = typeof tz === 'number';
['HST', -10], const localTz = tz === 'local' || (!numericTz && tz.toLowerCase?.() === 'local');
['AKST', -9], const tzName = localTz ? Intl.DateTimeFormat().resolvedOptions().timeZone : numericTz ? 'UTC' : tz;
['PST', -8],
['MST', -7],
['CST', -6],
['EST', -5],
['AST', -4],
['BRT', -3],
['MAT', -2],
['AZOT', -1],
['UTC', 0],
['CET', 1],
['EET', 2],
['MSK', 3],
['AST', 4],
['PKT', 5],
['IST', 5.5],
['BST', 6],
['ICT', 7],
['CST', 8],
['JST', 9],
['AEST', 10],
['SBT', 11],
['FJT', 12],
['TOT', 13],
['LINT', 14]
];
function adjustTz(date: Date, gmt: number) { if (!numericTz && tzName !== 'UTC') {
const currentOffset = date.getTimezoneOffset(); try {
const adjustedOffset = gmt * 60; new Intl.DateTimeFormat('en-US', { timeZone: tzName }).format();
return new Date(date.getTime() + (adjustedOffset + currentOffset) * 60000); } catch {
} throw new Error(`Invalid timezone: ${tzName}`);
function day(num: number): string {
return ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'][num] || 'Unknown';
}
function doy(date: Date) {
const start = new Date(`${date.getFullYear()}-01-01 0:00:00`);
return Math.ceil((date.getTime() - start.getTime()) / (1000 * 60 * 60 * 24));
}
function month(num: number): string {
return ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'][num] || 'Unknown';
}
function suffix(num: number) {
if (num % 100 >= 11 && num % 100 <= 13) return `${num}th`;
switch (num % 10) {
case 1: return `${num}st`;
case 2: return `${num}nd`;
case 3: return `${num}rd`;
default: return `${num}th`;
} }
} }
function tzOffset(offset: number) { let zonedDate = new Date(date);
const hours = ~~(offset / 60); if (!numericTz && tzName !== 'UTC') {
const minutes = offset % 60; const parts = new Intl.DateTimeFormat('en-US', {
return (offset > 0 ? '-' : '') + `${hours}:${minutes.toString().padStart(2, '0')}`; timeZone: tzName,
year: 'numeric', month: '2-digit', day: '2-digit',
hour: '2-digit', minute: '2-digit', second: '2-digit',
hour12: false
}).formatToParts(date);
const get = (type: string) => parts.find(p => p.type === type)?.value;
const build = `${get('year')}-${get('month')}-${get('day')}T${get('hour')}:${get('minute')}:${get('second')}Z`;
zonedDate = new Date(build);
} else if (numericTz || tzName === 'UTC') {
const offset = numericTz ? tz as number : 0;
zonedDate = new Date(date.getTime() + offset * 60 * 60 * 1000);
} }
if(typeof date == 'number' || typeof date == 'string' || date == null) date = new Date(date); const get = (fn: 'FullYear' | 'Month' | 'Date' | 'Day' | 'Hours' | 'Minutes' | 'Seconds' | 'Milliseconds') =>
(numericTz || tzName === 'UTC') ? zonedDate[`getUTC${fn}`]() : zonedDate[`get${fn}`]();
// Handle timezones function getTZOffset(): string {
let t!: [string, number]; if (numericTz) {
if(tz == null) tz = -(date.getTimezoneOffset() / 60); const total = (tz as number) * 60;
t = <any>timezones.find(t => isNaN(<any>tz) ? t[0] == tz : t[1] == tz); const hours = Math.floor(Math.abs(total) / 60);
if(!t) throw new Error(`Unknown timezone: ${tz}`); const mins = Math.abs(total) % 60;
date = adjustTz(date, t[1]); return `${tz >= 0 ? '+' : '-'}${String(hours).padStart(2, '0')}:${String(mins).padStart(2, '0')}`;
}
try {
const offset = new Intl.DateTimeFormat('en-US', {timeZone: tzName, timeZoneName: 'longOffset', hour: '2-digit', minute: '2-digit',})
.formatToParts(<Date>date).find(p => p.type === 'timeZoneName')?.value.match(/([+-]\d{2}:\d{2})/)?.[1];
if (offset) return offset;
} catch {}
return '+00:00';
}
function getTZAbbr(): string {
if (numericTz && tz === 0) return 'UTC';
try {
return new Intl.DateTimeFormat('en-US', { timeZone: tzName, timeZoneName: 'short' })
.formatToParts(<Date>date).find(p => p.type === 'timeZoneName')?.value || '';
} catch {
return tzName;
}
}
// Token mapping
const tokens: Record<string, string> = { const tokens: Record<string, string> = {
'YYYY': date.getFullYear().toString(), YYYY: get('FullYear').toString(),
'YY': date.getFullYear().toString().slice(2), YY: get('FullYear').toString().slice(2),
'MMMM': month(date.getMonth()), MMMM: month(get('Month')),
'MMM': month(date.getMonth()).slice(0, 3), MMM: month(get('Month')).slice(0, 3),
'MM': (date.getMonth() + 1).toString().padStart(2, '0'), MM: (get('Month') + 1).toString().padStart(2, '0'),
'M': (date.getMonth() + 1).toString(), M: (get('Month') + 1).toString(),
'DDD': doy(date).toString(), DDD: dayOfYear(zonedDate).toString(),
'DD': date.getDate().toString().padStart(2, '0'), DD: get('Date').toString().padStart(2, '0'),
'Do': suffix(date.getDate()), Do: numSuffix(get('Date')),
'D': date.getDate().toString(), D: get('Date').toString(),
'dddd': day(date.getDay()), dddd: dayOfWeek(get('Day')),
'ddd': day(date.getDay()).slice(0, 3), ddd: dayOfWeek(get('Day')).slice(0, 3),
'HH': date.getHours().toString().padStart(2, '0'), HH: get('Hours').toString().padStart(2, '0'),
'H': date.getHours().toString(), H: get('Hours').toString(),
'hh': (date.getHours() % 12 || 12).toString().padStart(2, '0'), hh: (get('Hours') % 12 || 12).toString().padStart(2, '0'),
'h': (date.getHours() % 12 || 12).toString(), h: (get('Hours') % 12 || 12).toString(),
'mm': date.getMinutes().toString().padStart(2, '0'), mm: get('Minutes').toString().padStart(2, '0'),
'm': date.getMinutes().toString(), m: get('Minutes').toString(),
'ss': date.getSeconds().toString().padStart(2, '0'), ss: get('Seconds').toString().padStart(2, '0'),
's': date.getSeconds().toString(), s: get('Seconds').toString(),
'SSS': date.getMilliseconds().toString().padStart(3, '0'), SSS: get('Milliseconds').toString().padStart(3, '0'),
'A': date.getHours() >= 12 ? 'PM' : 'AM', A: get('Hours') >= 12 ? 'PM' : 'AM',
'a': date.getHours() >= 12 ? 'pm' : 'am', a: get('Hours') >= 12 ? 'pm' : 'am',
'ZZ': tzOffset(t[1] * 60).replace(':', ''), ZZ: getTZOffset().replace(':', ''),
'Z': tzOffset(t[1] * 60), Z: getTZOffset(),
'z': typeof tz == 'string' ? tz : (<any>t)[0] z: getTZAbbr(),
}; };
return format.replace(/YYYY|YY|MMMM|MMM|MM|M|DDD|DD|Do|D|dddd|ddd|HH|H|hh|h|mm|m|ss|s|SSS|A|a|ZZ|Z|z/g, token => tokens[token]); return format.replace(/YYYY|YY|MMMM|MMM|MM|M|DDD|DD|Do|D|dddd|ddd|HH|H|hh|h|mm|m|ss|s|SSS|A|a|ZZ|Z|z/g, token => tokens[token]);
} }
@ -148,6 +142,10 @@ export function instantInterval(fn: () => any, interval: number) {
return setInterval(fn, interval); return setInterval(fn, interval);
} }
export function month(m: number): string {
return ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'][m];
}
/** /**
* Use in conjunction with `await` to pause an async script * Use in conjunction with `await` to pause an async script
* *

View File

@ -1,7 +1,7 @@
import {Cache} from '../src'; import { Cache } from '../src';
describe('Cache', () => { describe('Cache', () => {
type TestItem = { id: string; value: string; }; type TestItem = { id: string; value: string };
let cache: Cache<string, TestItem>; let cache: Cache<string, TestItem>;
let storageMock: Storage; let storageMock: Storage;
@ -10,6 +10,7 @@ describe('Cache', () => {
beforeEach(() => { beforeEach(() => {
storageMock = { storageMock = {
constructor: {name: 'Storage' as any},
getItem: jest.fn(), getItem: jest.fn(),
setItem: jest.fn(), setItem: jest.fn(),
removeItem: jest.fn(), removeItem: jest.fn(),
@ -17,93 +18,114 @@ describe('Cache', () => {
key: jest.fn(), key: jest.fn(),
length: 0, length: 0,
}; };
// Spies
storageGetItemSpy = jest.spyOn(storageMock, 'getItem'); storageGetItemSpy = jest.spyOn(storageMock, 'getItem');
storageSetItemSpy = jest.spyOn(storageMock, 'setItem'); storageSetItemSpy = jest.spyOn(storageMock, 'setItem');
cache = new Cache<string, TestItem>('id', {storage: storageMock, storageKey: 'cache'});
cache = new Cache<string, TestItem>('id', {
persistentStorage: { storage: storageMock, key: 'cache' },
});
jest.clearAllMocks(); jest.clearAllMocks();
jest.useFakeTimers(); jest.useFakeTimers();
}); });
test('should add and get an item', () => { it('adds and gets an item', () => {
const item = {id: '1', value: 'a'}; const item = { id: '1', value: 'a' };
cache.add(item); cache.add(item);
expect(cache.get('1')).toEqual(item); expect(cache.get('1')).toEqual(item);
}); });
test('should not get an expired item when expired option not set', () => { it('skips expired items by default but fetches if requested', () => {
const item = {id: '1', value: 'a'}; const item = { id: '2', value: 'b' };
cache.set('1', item); cache.set('2', item);
cache.options.expiryPolicy = 'keep'; cache.options.expiryPolicy = 'keep';
cache.expire('1'); cache.expire('2');
expect(cache.get('1')).toBeNull(); expect(cache.get('2')).toBeNull();
expect(cache.get('1', true)).toEqual({...item, _expired: true}); expect(cache.get('2', true)).toEqual({ ...item, _expired: true });
}); });
test('should set and get via property access (proxy)', () => { it('supports property access and setting via Proxy', () => {
(cache as any)['2'] = {id: '2', value: 'b'}; (cache as any)['3'] = { id: '3', value: 'c' };
expect((cache as any)['2']).toEqual({id: '2', value: 'b'}); expect((cache as any)['3']).toEqual({ id: '3', value: 'c' });
expect(cache.get('3')).toEqual({ id: '3', value: 'c' });
}); });
test('should remove an item', () => { it('removes an item and persists', () => {
cache.set('1', {id: '1', value: 'a'}); cache.add({ id: '4', value: 'd' });
cache.delete('1'); cache.delete('4');
expect(cache.get('1')).toBeNull(); expect(cache.get('4')).toBeNull();
expect(storageSetItemSpy).toHaveBeenCalled(); expect(storageSetItemSpy).toHaveBeenCalled();
}); });
test('should clear the cache', () => { it('clears the cache', () => {
cache.add({id: '1', value: 'a'}); cache.add({ id: '1', value: 'test' });
cache.clear(); cache.clear();
expect(cache.get('1')).toBeNull(); expect(cache.get('1')).toBeNull();
expect(cache.complete).toBe(false); expect(cache.complete).toBe(false);
}); });
test('should add multiple items and mark complete', () => { it('bulk adds, marks complete', () => {
const rows = [ const items = [
{id: 'a', value: '1'}, { id: 'a', value: '1' },
{id: 'b', value: '2'}, { id: 'b', value: '2' },
]; ];
cache.addAll(rows); cache.addAll(items);
expect(cache.all().length).toBe(2); expect(cache.all().length).toBe(2);
expect(cache.complete).toBe(true); expect(cache.complete).toBe(true);
}); });
test('should return all, keys, entries, and map', () => { it('returns correct keys, entries, and map', () => {
cache.add({id: '1', value: 'a'}); cache.add({ id: 'x', value: 'foo' });
cache.add({id: '2', value: 'b'}); cache.add({ id: 'y', value: 'bar' });
expect(cache.all().length).toBe(2); expect(cache.keys().sort()).toEqual(['x', 'y']);
expect(cache.keys().sort()).toEqual(['1', '2']); expect(cache.entries().map(e => e[0]).sort()).toEqual(['x', 'y']);
expect(cache.entries().length).toBe(2); const m = cache.map();
expect(Object.keys(cache.map())).toContain('1'); expect(Object.keys(m)).toEqual(expect.arrayContaining(['x', 'y']));
expect(Object.keys(cache.map())).toContain('2'); expect(m['x'].value).toBe('foo');
}); });
// test('should expire/delete items after TTL', () => { it('persists and restores from storage', () => {
// jest.useFakeTimers(); (storageMock.getItem as jest.Mock).mockReturnValueOnce(
// cache = new Cache<string, TestItem>('id', {ttl: 0.1}); JSON.stringify({ z: { id: 'z', value: 'from-storage' } }),
// cache.add({id: '3', value: 'x'}); );
// jest.advanceTimersByTime(250); const c = new Cache<string, TestItem>('id', {
// expect(cache.get('3')).toBeNull(); persistentStorage: { storage: storageMock, key: 'cache' },
});
expect(c.get('z')).toEqual({ id: 'z', value: 'from-storage' });
});
it('expiryPolicy "delete" removes expired items completely', () => {
cache.options.expiryPolicy = 'delete';
cache.add({ id: 'del1', value: 'gone' });
cache.expire('del1');
expect(cache.get('del1', true)).toBeNull();
expect(cache.get('del1')).toBeNull();
});
it('expiryPolicy "keep" marks as expired but does not delete', () => {
cache.options.expiryPolicy = 'keep';
cache.add({ id: 'keep1', value: 'kept' });
cache.expire('keep1');
expect(cache.get('keep1')).toBeNull();
const val = cache.get('keep1', true);
expect(val && val._expired).toBe(true);
});
// Uncomment and adapt this test if TTL/expiry timers are supported by your implementation
// it('expires and deletes items after TTL', () => {
// jest.useFakeTimers();
// cache = new Cache<string, TestItem>('id', { ttl: 0.01 });
// cache.add({ id: 'ttl1', value: 'temp' });
// jest.advanceTimersByTime(100);
// expect(cache.get('ttl1')).toBeNull();
// }); // });
test('should persist and restore from storage', () => { // Edge: add error handling test
(storageMock.getItem as jest.Mock).mockReturnValueOnce(JSON.stringify({a: {id: 'a', value: 'from-storage'}})); it('throws if instantiating with invalid key property', () => {
const c = new Cache<string, TestItem>('id', {storage: storageMock, storageKey: 'cache'}); expect(() => {
expect(c.get('a')).toEqual({id: 'a', value: 'from-storage'}); const invalid = new Cache<'string', TestItem>('id');
}); // try invalid.add({id: 'z', value: 'fail'}) if needed
}).not.toThrow();
test('should handle expiryPolicy "delete"', () => {
cache.options.expiryPolicy = 'delete';
cache.add({id: 'k1', value: 'KeepMe'});
cache.expire('k1');
expect(cache.get('k1', true)).toBeNull();
});
test('should handle expiryPolicy "keep"', () => {
cache.options.expiryPolicy = 'keep';
cache.add({id: 'k1', value: 'KeepMe'});
cache.expire('k1');
expect(cache.get('k1')).toBeNull();
expect(cache.get('k1', true)?._expired).toBe(true);
}); });
}); });

View File

@ -1,6 +1,10 @@
import {PathError, PathEvent, PathEventEmitter, PE, PES} from '../src'; import {PathError, PathEvent, PathEventEmitter, PE, PES} from '../src';
describe('Path Events', () => { describe('Path Events', () => {
beforeEach(() => {
PathEvent.clearCache();
});
describe('PE', () => { describe('PE', () => {
it('creates PathEvent from template string', () => { it('creates PathEvent from template string', () => {
const e = PE`users/system:cr`; const e = PE`users/system:cr`;

View File

@ -4,6 +4,7 @@ const rows = [
{id: 1, name: 'Alice', age: 30}, {id: 1, name: 'Alice', age: 30},
{id: 2, name: 'Bob', age: 24}, {id: 2, name: 'Bob', age: 24},
{id: 3, name: 'Carol', age: 30}, {id: 3, name: 'Carol', age: 30},
{id: 4, name: 'David', age: 35},
]; ];
describe('Search Utilities', () => { describe('Search Utilities', () => {
@ -37,6 +38,35 @@ describe('Search Utilities', () => {
it('returns all if search is falsy and regex enabled', () => { it('returns all if search is falsy and regex enabled', () => {
expect(search(rows, '', true)).toEqual(rows); expect(search(rows, '', true)).toEqual(rows);
}); });
it('handles regex search with special characters', () => {
expect(search(rows, '^[AC]', true)).toEqual([rows[0], rows[2]]);
});
it('ignores case when regex is applied', () => {
expect(search(rows, 'ALICE', true)).toEqual([]);
});
it('performs partial matches for properties when regex=false', () => {
expect(search(rows, 'Da')).toEqual([rows[3]]);
});
it('handles empty array input gracefully', () => {
expect(search([], 'test')).toEqual([]);
});
it('handles numeric values with comparison logic in strings', () => {
expect(search(rows, 'age < 31')).toEqual([rows[0], rows[1], rows[2]]);
});
// New test cases for `+` and `-` operators
it('filters rows using the + operator', () => {
expect(search(rows, 'name += Al')).toEqual([rows[0]]);
});
it('filters rows using the - operator', () => {
expect(search(rows, 'name -= Al')).toEqual([rows[1], rows[2], rows[3]]);
});
}); });
describe('logicTest', () => { describe('logicTest', () => {
@ -67,5 +97,46 @@ describe('Search Utilities', () => {
it('returns false for unsupported operators', () => { it('returns false for unsupported operators', () => {
expect(logicTest(obj, 'x === 10')).toBe(false); expect(logicTest(obj, 'x === 10')).toBe(false);
}); });
it('handles invalid condition strings gracefully', () => {
expect(logicTest(obj, 'invalid condition')).toBe(false);
});
it('supports numeric operations with ranges', () => {
expect(logicTest(obj, 'x > 5 && x < 15')).toBe(true);
expect(logicTest(obj, 'x > 15')).toBe(false);
});
it('handles mixed case keys gracefully', () => {
const mixedCaseObj = {TestKey: 123};
expect(logicTest(mixedCaseObj, 'TestKey == 123')).toBe(true);
expect(logicTest(mixedCaseObj, 'testkey == 123')).toBe(true);
});
it('returns false if condition operators are missing', () => {
expect(logicTest(obj, 'x 10')).toBe(false);
});
// New test cases for `+` and `-` operators
it('handles the + operator for inclusion', () => {
expect(logicTest(obj, 'name += Alpha')).toBe(true);
expect(logicTest(obj, 'name += Alp')).toBe(true);
expect(logicTest(obj, 'name += Bet')).toBe(false);
});
it('handles the - operator for exclusion', () => {
expect(logicTest(obj, 'name -= Alpha')).toBe(false);
expect(logicTest(obj, 'name -= Alp')).toBe(false);
expect(logicTest(obj, 'name -= Bet')).toBe(true);
});
it('includes partial matches correctly with +', () => {
expect(logicTest(obj, 'name += lph')).toBe(true);
});
it('excludes partial matches correctly with -', () => {
expect(logicTest(obj, 'name -= lph')).toBe(false);
expect(logicTest(obj, 'name -= xyz')).toBe(true);
});
}); });
}); });

View File

@ -31,11 +31,11 @@ describe('Time Utilities', () => {
it('handles formatting for given timestamp', () => { it('handles formatting for given timestamp', () => {
const timestamp = Date.UTC(2023, 1, 1, 18, 5, 5, 123); // Feb 1, 2023 18:05:05.123 UTC const timestamp = Date.UTC(2023, 1, 1, 18, 5, 5, 123); // Feb 1, 2023 18:05:05.123 UTC
const formatted = formatDate('YYYY MM DD HH mm ss SSS A Z', timestamp, 'UTC'); const formatted = formatDate('YYYY MM DD HH mm ss SSS A Z', timestamp, 'UTC');
expect(formatted).toMatch(/^2023 02 01 18 05 05 123 PM \+?0:00$/i); expect(formatted).toMatch(/^2023 02 01 18 05 05 123 PM \+00:00/i);
}); });
it('throws for unknown timezone', () => { it('throws for unknown timezone', () => {
expect(() => formatDate('YYYY', new Date(), '???')).toThrowError(/Unknown timezone/); expect(() => formatDate('YYYY', new Date(), '???')).toThrowError(/Invalid timezone/);
}); });
it('handles timezone by offset number', () => { it('handles timezone by offset number', () => {