Compare commits
33 Commits
Author | SHA1 | Date | |
---|---|---|---|
bfe9493d23 | |||
1b6fe42f78 | |||
c3d8d75ba3 | |||
e2d756fe28 | |||
52f64f9e78 | |||
4caf0e5048 | |||
55b871f4c1 | |||
fb077775b6 | |||
2d2b2b8216 | |||
b473ade178 | |||
b3223661dd | |||
c36af83918 | |||
9ec70430a5 | |||
397b165e55 | |||
c1577c2106 | |||
2b12916246 | |||
5efb045f22 | |||
7119390681 | |||
fd95c0c697 | |||
1ab8e6424b | |||
035a1d35cb | |||
e78120b067 | |||
71552aa243 | |||
ce3878e18b | |||
388a09718b | |||
59bce9d28d | |||
387e6b2512 | |||
d748d740ea | |||
c8f44584a2 | |||
8b84d170a6 | |||
37df7e6090 | |||
a8b6fdd5a6 | |||
3e899e6ae4 |
@ -1,9 +1,9 @@
|
||||
<html>
|
||||
<body>
|
||||
<script type="module">
|
||||
import {PES} from './dist/index.mjs';
|
||||
import {PE} from './dist/index.mjs';
|
||||
|
||||
console.log(PES`storage${'Test/Test'}:d`);
|
||||
console.log('data/Ts:n', PE`${'data/Ts'}:n`.methods);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@ztimson/utils",
|
||||
"version": "0.25.25",
|
||||
"version": "0.26.26",
|
||||
"description": "Utility library",
|
||||
"author": "Zak Timson",
|
||||
"license": "MIT",
|
||||
|
70
src/cache.ts
70
src/cache.ts
@ -1,13 +1,11 @@
|
||||
import {Table} from './database.ts';
|
||||
import {Database, Table} from './database.ts';
|
||||
import {deepCopy, includes, JSONSanitize} from './objects.ts';
|
||||
|
||||
export type CacheOptions = {
|
||||
/** Delete keys automatically after x amount of seconds */
|
||||
ttl?: number;
|
||||
/** Storage to persist cache */
|
||||
storage?: Storage | Table<any, any>;
|
||||
/** Key cache will be stored under */
|
||||
storageKey?: string;
|
||||
persistentStorage?: {storage: Storage | Database, key: string} | string;
|
||||
/** Keep or delete cached items once expired, defaults to delete */
|
||||
expiryPolicy?: 'delete' | 'keep';
|
||||
}
|
||||
@ -24,8 +22,10 @@ export class Cache<K extends string | number | symbol, T> {
|
||||
[key: string | number | symbol]: CachedValue<T> | any;
|
||||
/** Whether cache is complete */
|
||||
complete = false;
|
||||
|
||||
private _loading!: Function;
|
||||
/** Await initial loading */
|
||||
loading!: Promise<void>;
|
||||
loading = new Promise<void>(r => this._loading = r);
|
||||
|
||||
/**
|
||||
* Create new cache
|
||||
@ -33,21 +33,29 @@ export class Cache<K extends string | number | symbol, T> {
|
||||
* @param options
|
||||
*/
|
||||
constructor(public readonly key?: keyof T, public readonly options: CacheOptions = {}) {
|
||||
let resolve: any;
|
||||
this.loading = new Promise(r => resolve = r);
|
||||
if(options.storageKey && !options.storage && typeof(Storage) !== 'undefined') options.storage = localStorage;
|
||||
if(options.storage) {
|
||||
if(options.storage instanceof Table) {
|
||||
// Persistent storage
|
||||
if(this.options.persistentStorage != null) {
|
||||
if(typeof this.options.persistentStorage == 'string')
|
||||
this.options.persistentStorage = {storage: localStorage, key: this.options.persistentStorage};
|
||||
|
||||
if(this.options.persistentStorage?.storage?.database != undefined) {
|
||||
(async () => {
|
||||
this.addAll(await options.storage?.getAll(), false);
|
||||
resolve();
|
||||
})()
|
||||
} else if(options.storageKey) {
|
||||
const stored = options.storage?.getItem(options.storageKey);
|
||||
const persists: any = this.options.persistentStorage;
|
||||
const table: Table<any, any> = await persists.storage.createTable({name: persists.key, key: this.key});
|
||||
const rows = await table.getAll();
|
||||
Object.assign(this.store, rows.reduce((acc, row) => ({...acc, [this.getKey(row)]: row}), {}));
|
||||
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 { }
|
||||
resolve();
|
||||
this._loading();
|
||||
}
|
||||
} else resolve();
|
||||
} else {
|
||||
this._loading();
|
||||
}
|
||||
|
||||
// Handle index lookups
|
||||
return new Proxy(this, {
|
||||
get: (target: this, prop: string | symbol) => {
|
||||
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) {
|
||||
if(this.options.storage) {
|
||||
if(this.options.storage instanceof Table) {
|
||||
if(key == null) {
|
||||
let rows: any = this.entries();
|
||||
rows.forEach(([k, v]: [string, any]) => this.options.storage?.put(k, v));
|
||||
rows = rows.map(([k]: [string]) => k);
|
||||
this.options.storage.getAllKeys().then(keys =>
|
||||
keys.filter(k => !rows.includes(k))
|
||||
.forEach(k => this.options.storage?.delete(k)));
|
||||
} else if(this.store[key] === undefined) this.options.storage.delete(key);
|
||||
else this.options.storage.put(key, this.store[key]);
|
||||
} else if(this.options.storageKey) {
|
||||
this.options.storage.setItem(this.options.storageKey, JSONSanitize(this.store));
|
||||
const persists: {storage: any, key: string} = <any>this.options.persistentStorage;
|
||||
if(!!persists?.storage) {
|
||||
if(persists.storage?.database != undefined) {
|
||||
(<Database>persists.storage).createTable({name: persists.key, key: <string>this.key}).then(table => {
|
||||
if(key) {
|
||||
const value = this.get(key);
|
||||
if(value != null) table.set(value, key);
|
||||
else table.delete(key);
|
||||
} else {
|
||||
table.clear();
|
||||
this.all().forEach(row => table.add(row));
|
||||
}
|
||||
});
|
||||
} else if(persists.storage?.setItem != undefined) {
|
||||
persists.storage.setItem(persists.storage.key, JSONSanitize(this.all(true)));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -14,8 +14,8 @@ class AsyncLock {
|
||||
const res = this.p.then(fn, fn);
|
||||
this.p = res.then(() => {}, () => {});
|
||||
return res;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export class Database {
|
||||
private schemaLock = new AsyncLock();
|
||||
@ -28,7 +28,10 @@ export class Database {
|
||||
|
||||
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);
|
||||
let req: IDBOpenDBRequest;
|
||||
try { req = indexedDB.open(this.database, this.version); }
|
||||
catch (err) { return reject(err); }
|
||||
|
||||
this.tables = !tables ? [] : tables.map(t => {
|
||||
t = typeof t == 'object' ? t : {name: t};
|
||||
return {...t, name: t.name.toString()};
|
||||
@ -37,13 +40,22 @@ export class Database {
|
||||
req.onerror = () => reject(req.error);
|
||||
|
||||
req.onsuccess = () => {
|
||||
const db = req.result;
|
||||
let db: IDBDatabase;
|
||||
try { db = req.result; }
|
||||
catch (err) { return reject(err); }
|
||||
|
||||
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};
|
||||
});
|
||||
if(!tables) {
|
||||
this.tables = existing.map(t => {
|
||||
try {
|
||||
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));
|
||||
if(tables && desired.symmetricDifference(new ASet(existing)).length) {
|
||||
db.close();
|
||||
@ -58,19 +70,23 @@ export class Database {
|
||||
|
||||
req.onupgradeneeded = () => {
|
||||
this.upgrading = true;
|
||||
const db = req.result;
|
||||
const existingTables = new ASet(Array.from(db.objectStoreNames));
|
||||
if(tables) {
|
||||
const desired = new ASet((tables || []).map(t => typeof t == 'string' ? t : t.name));
|
||||
existingTables.difference(desired).forEach(name => db.deleteObjectStore(name));
|
||||
desired.difference(existingTables).forEach(name => {
|
||||
const t = this.tables.find(findByProp('name', name));
|
||||
db.createObjectStore(name, {
|
||||
keyPath: t?.key,
|
||||
autoIncrement: t?.autoIncrement || !t?.key,
|
||||
let db: IDBDatabase;
|
||||
try { db = req.result; }
|
||||
catch { return; }
|
||||
try {
|
||||
const existingTables = new ASet(Array.from(db.objectStoreNames));
|
||||
if(tables) {
|
||||
const desired = new ASet((tables || []).map(t => typeof t == 'string' ? t : t.name));
|
||||
existingTables.difference(desired).forEach(name => db.deleteObjectStore(name));
|
||||
desired.difference(existingTables).forEach(name => {
|
||||
const t = this.tables.find(findByProp('name', name));
|
||||
db.createObjectStore(name, {
|
||||
keyPath: t?.key,
|
||||
autoIncrement: t?.autoIncrement || !t?.key,
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
}
|
||||
} catch { }
|
||||
};
|
||||
});
|
||||
}
|
||||
@ -82,9 +98,11 @@ export class Database {
|
||||
if(typeof table == 'string') table = { name: table };
|
||||
const conn = await this.connection;
|
||||
if(!this.includes(table.name)) {
|
||||
const newDb = new Database(this.database, [...this.tables, table], (this.version ?? 0) + 1);
|
||||
conn.close();
|
||||
Object.assign(this, new Database(this.database, [...this.tables, table], (this.version ?? 0) + 1));
|
||||
this.connection = newDb.connection;
|
||||
await this.connection;
|
||||
Object.assign(this, newDb);
|
||||
}
|
||||
return this.table<K, T>(table.name);
|
||||
});
|
||||
@ -95,9 +113,11 @@ export class Database {
|
||||
if(typeof table == 'string') table = { name: table };
|
||||
if(!this.includes(table.name)) return;
|
||||
const conn = await this.connection;
|
||||
const newDb = new Database(this.database, this.tables.filter(t => t.name != (<TableOptions>table).name), (this.version ?? 0) + 1);
|
||||
conn.close();
|
||||
Object.assign(this, new Database(this.database, this.tables.filter(t => t.name != (<TableOptions>table).name), (this.version ?? 0) + 1));
|
||||
this.connection = newDb.connection;
|
||||
await this.connection;
|
||||
Object.assign(this, newDb);
|
||||
});
|
||||
}
|
||||
|
||||
@ -122,9 +142,8 @@ export class Table<K extends IDBValidKey = any, T = any> {
|
||||
await this.database.waitForUpgrade();
|
||||
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);
|
||||
const request = fn(tx.objectStore(table));
|
||||
request.onsuccess = () => resolve(request.result as R);
|
||||
request.onerror = () => reject(request.error);
|
||||
});
|
||||
@ -162,8 +181,11 @@ export class Table<K extends IDBValidKey = any, T = any> {
|
||||
return this.tx(this.name, store => store.getAllKeys(), true);
|
||||
}
|
||||
|
||||
put(key: K, value: T): Promise<void> {
|
||||
return this.tx(this.name, store => store.put(value, key));
|
||||
put(value: T, key?: string): Promise<void> {
|
||||
return this.tx(this.name, store => {
|
||||
if(store.keyPath) return store.put(value);
|
||||
return store.put(value, key);
|
||||
});
|
||||
}
|
||||
|
||||
read(): Promise<T[]>;
|
||||
@ -173,8 +195,9 @@ export class Table<K extends IDBValidKey = any, T = any> {
|
||||
}
|
||||
|
||||
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);
|
||||
if(key) (<any>value)[this.key] = key;
|
||||
if(!(<any>value)[this.key]) return this.add(value);
|
||||
return this.put(value);
|
||||
}
|
||||
|
||||
update = this.set;
|
||||
|
@ -78,7 +78,7 @@ export class Http {
|
||||
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 || '');
|
||||
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) {
|
||||
const q = Array.isArray(opts.query) ? opts.query :
|
||||
Object.keys(opts.query).map(k => ({key: k, value: (<any>opts.query)[k]}))
|
||||
|
25
src/misc.ts
25
src/misc.ts
@ -1,9 +1,21 @@
|
||||
import {PathEvent} from './path-events.ts';
|
||||
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
|
||||
*
|
||||
* @param {string} value String which should be escaped
|
||||
* @return {string} New escaped sequence
|
||||
*/
|
||||
@ -47,6 +59,17 @@ export function ipV6ToV4(ip: string) {
|
||||
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.
|
||||
*
|
||||
|
103
src/objects.ts
103
src/objects.ts
@ -1,3 +1,58 @@
|
||||
export type Delta = { [key: string]: any | Delta | null };
|
||||
|
||||
/**
|
||||
* Applies deltas in order to modify `target`.
|
||||
* @param target - Object to mutate
|
||||
* @param deltas - List of deltas to apply
|
||||
* @returns Mutated target
|
||||
*/
|
||||
export function applyDeltas(target: any, deltas: Delta[]): any {
|
||||
for(const delta of deltas) {
|
||||
for(const [key, value] of Object.entries(delta)) {
|
||||
if(value === null) {
|
||||
delete target[key]; // Remove
|
||||
} else if(Array.isArray(value)) {
|
||||
target[key] = [...value]; // Array
|
||||
} else if(typeof value === 'object') {
|
||||
if(typeof target[key] !== 'object' || Array.isArray(target[key]) || !target[key])
|
||||
target[key] = {}; // Nested
|
||||
applyDeltas(target[key], [value]); // Recurse
|
||||
} else {
|
||||
target[key] = value; // Primitive
|
||||
}
|
||||
}
|
||||
}
|
||||
return target;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a nested delta that reverts `target` back to `old`.
|
||||
* @param old - Original object
|
||||
* @param target - Modified object
|
||||
* @returns Delta to revert changes
|
||||
*/
|
||||
export function calcDelta(old: any, target: any): Delta {
|
||||
const delta: Delta = {};
|
||||
const keys = new Set([...Object.keys(old || {}), ...Object.keys(target || {})]);
|
||||
for(const key of keys) {
|
||||
const val1 = old?.[key];
|
||||
const val2 = target?.[key];
|
||||
if(!(key in target)) {
|
||||
delta[key] = val1; // Removed
|
||||
} else if(!(key in old)) {
|
||||
delta[key] = null; // Added
|
||||
} else if(Array.isArray(val1) || Array.isArray(val2)) {
|
||||
if(JSON.stringify(val1) !== JSON.stringify(val2)) delta[key] = val1; // Array
|
||||
} else if(typeof val1 === 'object' && typeof val2 === 'object' && val1 && val2) {
|
||||
const nested = calcDelta(val1, val2);
|
||||
if(Object.keys(nested).length) delta[key] = nested; // Nested
|
||||
} else if(val1 !== val2) {
|
||||
delta[key] = val1; // Modified
|
||||
}
|
||||
}
|
||||
return delta;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes any null values from an object in-place
|
||||
*
|
||||
@ -177,19 +232,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} b - second item to compare
|
||||
* @param {WeakMap<object, object>} [seen] - Internal parameter to track circular references
|
||||
* @returns {boolean} True if they match
|
||||
*/
|
||||
export function isEqual(a: any, b: any): boolean {
|
||||
const ta = typeof a, tb = typeof b;
|
||||
if((ta != 'object' || a == null) || (tb != 'object' || b == null))
|
||||
return ta == 'function' && tb == 'function' ? a.toString() == b.toString() : a === b;
|
||||
const keys = Object.keys(a);
|
||||
if(keys.length != Object.keys(b).length) return false;
|
||||
return Object.keys(a).every(key => isEqual(a[key], b[key]));
|
||||
export function isEqual(a: any, b: any, seen = new WeakMap<object, object>()): boolean {
|
||||
// Simple cases
|
||||
if(a === b) return true;
|
||||
if(a instanceof Date && b instanceof Date) return a.getTime() === b.getTime();
|
||||
if(a instanceof RegExp && b instanceof RegExp) return a.source === b.source && a.flags === b.flags;
|
||||
|
||||
// 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;
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -71,9 +71,12 @@ export class PathEvent {
|
||||
/** List of methods */
|
||||
methods!: ASet<Method>;
|
||||
|
||||
/** Internal cache for PathEvent instances to avoid redundant parsing */
|
||||
private static pathEventCache: Map<string, PathEvent> = new Map();
|
||||
|
||||
/** All/Wildcard specified */
|
||||
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 */
|
||||
get none(): boolean { return this.methods.has('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'); }
|
||||
|
||||
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(':');
|
||||
if(!method) method = scope || '*';
|
||||
if(p == '*' || !p && method == '*') {
|
||||
if(p == '*' || (!p && method == '*')) {
|
||||
p = '';
|
||||
method = '*';
|
||||
}
|
||||
@ -104,6 +117,14 @@ export class PathEvent {
|
||||
this.fullPath = `${this.module}${this.module && this.path ? '/' : ''}${this.path}`;
|
||||
this.name = temp.pop() || '';
|
||||
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 {
|
||||
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) => {
|
||||
const l1 = p1.fullPath.length, l2 = p2.fullPath.length;
|
||||
return l1 < l2 ? 1 : (l1 > l2 ? -1 : 0);
|
||||
@ -124,10 +145,9 @@ export class PathEvent {
|
||||
if(p.none) hitNone = true;
|
||||
if(!acc) return p;
|
||||
if(hitNone) return acc;
|
||||
acc.methods = [...acc.methods, ...p.methods];
|
||||
acc.methods = new ASet([...acc.methods, ...p.methods]);
|
||||
return acc;
|
||||
}, <any>null);
|
||||
combined.methods = new ASet<Method>(combined.methods);
|
||||
return combined;
|
||||
}
|
||||
|
||||
@ -139,11 +159,12 @@ export class PathEvent {
|
||||
* @return {boolean} Whether there is any overlap
|
||||
*/
|
||||
static filter(target: string | PathEvent | (string | PathEvent)[], ...filter: (string | PathEvent)[]): PathEvent[] {
|
||||
const parsedTarget = makeArray(target).map(pe => new PathEvent(pe));
|
||||
const parsedFilter = makeArray(filter).map(pe => new PathEvent(pe));
|
||||
const parsedTarget = makeArray(target).map(pe => pe instanceof PathEvent ? pe : new PathEvent(pe));
|
||||
const parsedFilter = makeArray(filter).map(pe => pe instanceof PathEvent ? pe : new PathEvent(pe));
|
||||
return parsedTarget.filter(t => !!parsedFilter.find(r => {
|
||||
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 methods = r.all || t.all || r.methods.intersection(t.methods).length;
|
||||
return (wildcard || scope) && methods;
|
||||
@ -158,12 +179,13 @@ export class PathEvent {
|
||||
* @return {boolean} Whether there is any overlap
|
||||
*/
|
||||
static has(target: string | PathEvent | (string | PathEvent)[], ...has: (string | PathEvent)[]): boolean {
|
||||
const parsedTarget = makeArray(target).map(pe => new PathEvent(pe));
|
||||
const parsedRequired = makeArray(has).map(pe => new PathEvent(pe));
|
||||
const parsedTarget = makeArray(target).map(pe => pe instanceof PathEvent ? pe : new PathEvent(pe));
|
||||
const parsedRequired = makeArray(has).map(pe => pe instanceof PathEvent ? pe : new PathEvent(pe));
|
||||
return !!parsedRequired.find(r => !!parsedTarget.find(t => {
|
||||
const wildcard = r.fullPath == '*' || t.fullPath == '*';
|
||||
const p1 = r.fullPath.slice(0, r.fullPath.indexOf('*')), p2 = t.fullPath.slice(0, t.fullPath.indexOf('*'))
|
||||
const scope = p1.startsWith(p2);
|
||||
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); // 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;
|
||||
return (wildcard || scope) && methods;
|
||||
}));
|
||||
@ -293,7 +315,7 @@ export class PathEventEmitter implements IPathEventEmitter{
|
||||
constructor(public readonly prefix: string = '') { }
|
||||
|
||||
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))
|
||||
.forEach(async l => l[1](parsed, ...args));
|
||||
};
|
||||
@ -303,10 +325,13 @@ export class PathEventEmitter implements IPathEventEmitter{
|
||||
}
|
||||
|
||||
on(event: Event | Event[], listener: PathListener): PathUnsubscribe {
|
||||
makeArray(event).forEach(e => this.listeners.push([
|
||||
new PathEvent(`${this.prefix}/${e}`),
|
||||
listener
|
||||
]));
|
||||
makeArray(event).forEach(e => {
|
||||
if(typeof e == 'string' && e[0] == '*' && this.prefix) e = e.slice(1);
|
||||
this.listeners.push([
|
||||
e instanceof PathEvent ? e : new PathEvent(`${this.prefix}/${e}`),
|
||||
listener
|
||||
])
|
||||
});
|
||||
return () => this.off(listener);
|
||||
}
|
||||
|
||||
|
@ -13,8 +13,8 @@ export function search(rows: any[], search: string, regex?: boolean, transform:
|
||||
if(!rows) return [];
|
||||
return rows.filter(r => {
|
||||
// Empty search
|
||||
const value = transform(r);
|
||||
if(!search) return true;
|
||||
const value = transform(r);
|
||||
// Regex search
|
||||
if(regex) {
|
||||
return !!Object.values(value).filter((v: any) => {
|
||||
@ -22,7 +22,7 @@ export function search(rows: any[], search: string, regex?: boolean, transform:
|
||||
catch { return false; }
|
||||
}).length
|
||||
} else {
|
||||
return logicTest(r, search);
|
||||
return logicTest(value, search);
|
||||
}
|
||||
});
|
||||
}
|
||||
@ -39,6 +39,8 @@ export function logicTest(target: object, condition: string): boolean {
|
||||
case '=':
|
||||
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;
|
||||
@ -53,7 +55,7 @@ export function logicTest(target: object, condition: string): boolean {
|
||||
const and = p.split('&&').map(p => p.trim()).filter(p => !!p);
|
||||
return and.filter(p => {
|
||||
// Boolean operator
|
||||
const prop = /(\S+)\s*(==?|!=|>=|>|<=|<)\s*(\S+)/g.exec(p);
|
||||
const prop = /(\S+)\s*(==?|!=|\+=|-=|>=|>|<=|<)\s*(\S+)/g.exec(p);
|
||||
if(prop) {
|
||||
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]));
|
||||
|
@ -43,6 +43,24 @@ export function formatBytes(bytes: number, decimals = 2) {
|
||||
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
|
||||
*
|
||||
|
@ -1,7 +1,7 @@
|
||||
import {Cache} from '../src';
|
||||
import { Cache } from '../src';
|
||||
|
||||
describe('Cache', () => {
|
||||
type TestItem = { id: string; value: string; };
|
||||
type TestItem = { id: string; value: string };
|
||||
|
||||
let cache: Cache<string, TestItem>;
|
||||
let storageMock: Storage;
|
||||
@ -10,6 +10,7 @@ describe('Cache', () => {
|
||||
|
||||
beforeEach(() => {
|
||||
storageMock = {
|
||||
constructor: {name: 'Storage' as any},
|
||||
getItem: jest.fn(),
|
||||
setItem: jest.fn(),
|
||||
removeItem: jest.fn(),
|
||||
@ -17,93 +18,114 @@ describe('Cache', () => {
|
||||
key: jest.fn(),
|
||||
length: 0,
|
||||
};
|
||||
|
||||
// Spies
|
||||
storageGetItemSpy = jest.spyOn(storageMock, 'getItem');
|
||||
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.useFakeTimers();
|
||||
});
|
||||
|
||||
test('should add and get an item', () => {
|
||||
const item = {id: '1', value: 'a'};
|
||||
it('adds and gets an item', () => {
|
||||
const item = { id: '1', value: 'a' };
|
||||
cache.add(item);
|
||||
expect(cache.get('1')).toEqual(item);
|
||||
});
|
||||
|
||||
test('should not get an expired item when expired option not set', () => {
|
||||
const item = {id: '1', value: 'a'};
|
||||
cache.set('1', item);
|
||||
it('skips expired items by default but fetches if requested', () => {
|
||||
const item = { id: '2', value: 'b' };
|
||||
cache.set('2', item);
|
||||
cache.options.expiryPolicy = 'keep';
|
||||
cache.expire('1');
|
||||
expect(cache.get('1')).toBeNull();
|
||||
expect(cache.get('1', true)).toEqual({...item, _expired: true});
|
||||
cache.expire('2');
|
||||
expect(cache.get('2')).toBeNull();
|
||||
expect(cache.get('2', true)).toEqual({ ...item, _expired: true });
|
||||
});
|
||||
|
||||
test('should set and get via property access (proxy)', () => {
|
||||
(cache as any)['2'] = {id: '2', value: 'b'};
|
||||
expect((cache as any)['2']).toEqual({id: '2', value: 'b'});
|
||||
it('supports property access and setting via Proxy', () => {
|
||||
(cache as any)['3'] = { id: '3', value: 'c' };
|
||||
expect((cache as any)['3']).toEqual({ id: '3', value: 'c' });
|
||||
expect(cache.get('3')).toEqual({ id: '3', value: 'c' });
|
||||
});
|
||||
|
||||
test('should remove an item', () => {
|
||||
cache.set('1', {id: '1', value: 'a'});
|
||||
cache.delete('1');
|
||||
expect(cache.get('1')).toBeNull();
|
||||
it('removes an item and persists', () => {
|
||||
cache.add({ id: '4', value: 'd' });
|
||||
cache.delete('4');
|
||||
expect(cache.get('4')).toBeNull();
|
||||
expect(storageSetItemSpy).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
test('should clear the cache', () => {
|
||||
cache.add({id: '1', value: 'a'});
|
||||
it('clears the cache', () => {
|
||||
cache.add({ id: '1', value: 'test' });
|
||||
cache.clear();
|
||||
expect(cache.get('1')).toBeNull();
|
||||
expect(cache.complete).toBe(false);
|
||||
});
|
||||
|
||||
test('should add multiple items and mark complete', () => {
|
||||
const rows = [
|
||||
{id: 'a', value: '1'},
|
||||
{id: 'b', value: '2'},
|
||||
it('bulk adds, marks complete', () => {
|
||||
const items = [
|
||||
{ id: 'a', value: '1' },
|
||||
{ id: 'b', value: '2' },
|
||||
];
|
||||
cache.addAll(rows);
|
||||
cache.addAll(items);
|
||||
expect(cache.all().length).toBe(2);
|
||||
expect(cache.complete).toBe(true);
|
||||
});
|
||||
|
||||
test('should return all, keys, entries, and map', () => {
|
||||
cache.add({id: '1', value: 'a'});
|
||||
cache.add({id: '2', value: 'b'});
|
||||
expect(cache.all().length).toBe(2);
|
||||
expect(cache.keys().sort()).toEqual(['1', '2']);
|
||||
expect(cache.entries().length).toBe(2);
|
||||
expect(Object.keys(cache.map())).toContain('1');
|
||||
expect(Object.keys(cache.map())).toContain('2');
|
||||
it('returns correct keys, entries, and map', () => {
|
||||
cache.add({ id: 'x', value: 'foo' });
|
||||
cache.add({ id: 'y', value: 'bar' });
|
||||
expect(cache.keys().sort()).toEqual(['x', 'y']);
|
||||
expect(cache.entries().map(e => e[0]).sort()).toEqual(['x', 'y']);
|
||||
const m = cache.map();
|
||||
expect(Object.keys(m)).toEqual(expect.arrayContaining(['x', 'y']));
|
||||
expect(m['x'].value).toBe('foo');
|
||||
});
|
||||
|
||||
// test('should expire/delete items after TTL', () => {
|
||||
// jest.useFakeTimers();
|
||||
// cache = new Cache<string, TestItem>('id', {ttl: 0.1});
|
||||
// cache.add({id: '3', value: 'x'});
|
||||
// jest.advanceTimersByTime(250);
|
||||
// expect(cache.get('3')).toBeNull();
|
||||
it('persists and restores from storage', () => {
|
||||
(storageMock.getItem as jest.Mock).mockReturnValueOnce(
|
||||
JSON.stringify({ z: { id: 'z', value: 'from-storage' } }),
|
||||
);
|
||||
const c = new Cache<string, TestItem>('id', {
|
||||
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', () => {
|
||||
(storageMock.getItem as jest.Mock).mockReturnValueOnce(JSON.stringify({a: {id: 'a', value: 'from-storage'}}));
|
||||
const c = new Cache<string, TestItem>('id', {storage: storageMock, storageKey: 'cache'});
|
||||
expect(c.get('a')).toEqual({id: 'a', value: 'from-storage'});
|
||||
});
|
||||
|
||||
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);
|
||||
// Edge: add error handling test
|
||||
it('throws if instantiating with invalid key property', () => {
|
||||
expect(() => {
|
||||
const invalid = new Cache<'string', TestItem>('id');
|
||||
// try invalid.add({id: 'z', value: 'fail'}) if needed
|
||||
}).not.toThrow();
|
||||
});
|
||||
});
|
||||
|
@ -1,6 +1,10 @@
|
||||
import {PathError, PathEvent, PathEventEmitter, PE, PES} from '../src';
|
||||
|
||||
describe('Path Events', () => {
|
||||
beforeEach(() => {
|
||||
PathEvent.clearCache();
|
||||
});
|
||||
|
||||
describe('PE', () => {
|
||||
it('creates PathEvent from template string', () => {
|
||||
const e = PE`users/system:cr`;
|
||||
|
@ -4,6 +4,7 @@ const rows = [
|
||||
{id: 1, name: 'Alice', age: 30},
|
||||
{id: 2, name: 'Bob', age: 24},
|
||||
{id: 3, name: 'Carol', age: 30},
|
||||
{id: 4, name: 'David', age: 35},
|
||||
];
|
||||
|
||||
describe('Search Utilities', () => {
|
||||
@ -37,6 +38,35 @@ describe('Search Utilities', () => {
|
||||
it('returns all if search is falsy and regex enabled', () => {
|
||||
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', () => {
|
||||
@ -67,5 +97,46 @@ describe('Search Utilities', () => {
|
||||
it('returns false for unsupported operators', () => {
|
||||
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);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
Reference in New Issue
Block a user