Compare commits

...

22 Commits

Author SHA1 Message Date
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
11 changed files with 244 additions and 56 deletions

View File

@ -1,11 +1,9 @@
<html>
<body>
<script type="module">
import {PathEventEmitter} from './dist/index.mjs';
import {PE} from './dist/index.mjs';
const emitter = new PathEventEmitter('data');
emitter.on('*', console.log);
emitter.emit('data/asd', {});
console.log('data/Ts:n', PE`${'data/Ts'}:n`.methods);
</script>
</body>
</html>

View File

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

View File

@ -22,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
@ -31,27 +33,26 @@ export class Cache<K extends string | number | symbol, T> {
* @param options
*/
constructor(public readonly key?: keyof T, public readonly options: CacheOptions = {}) {
let done!: Function;
this.loading = new Promise(r => done = r);
// 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?.constructor.name == 'Database') {
if(this.options.persistentStorage?.storage?.database != undefined) {
(async () => {
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}), {}));
done();
this._loading();
})();
} else if(this.options.persistentStorage?.storage?.constructor.name == 'Storage') {
} 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 { }
done();
this._loading();
}
} else {
this._loading();
}
// Handle index lookups
@ -77,16 +78,18 @@ export class Cache<K extends string | number | symbol, T> {
private save(key?: K) {
const persists: {storage: any, key: string} = <any>this.options.persistentStorage;
if(!!persists?.storage) {
if(persists.storage?.constructor.name == 'Database') {
if(persists.storage?.database != undefined) {
(<Database>persists.storage).createTable({name: persists.key, key: <string>this.key}).then(table => {
if(key) {
table.set(this.get(key), 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?.constructor.name == 'Storage') {
} else if(persists.storage?.setItem != undefined) {
persists.storage.setItem(persists.storage.key, JSONSanitize(this.all(true)));
}
}

View File

@ -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 { }
};
});
}
@ -79,30 +95,30 @@ export class Database {
async createTable<K extends IDBValidKey = any, T = any>(table: string | TableOptions): Promise<Table<K, T>> {
return this.schemaLock.run(async () => {
if (typeof table == 'string') table = { name: table };
if(typeof table == 'string') table = { name: table };
const conn = await this.connection;
if (!this.includes(table.name)) {
if(!this.includes(table.name)) {
const newDb = new Database(this.database, [...this.tables, table], (this.version ?? 0) + 1);
conn.close();
Object.assign(this, newDb);
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> {
return this.schemaLock.run(async () => {
if (typeof table == 'string') table = { name: table };
if (!this.includes(table.name)) return;
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, newDb);
this.connection = newDb.connection;
await this.connection;
Object.assign(this, newDb);
});
}
includes(name: any): boolean {
@ -126,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);
});
@ -168,7 +183,7 @@ export class Table<K extends IDBValidKey = any, T = any> {
put(value: T, key?: string): Promise<void> {
return this.tx(this.name, store => {
if (store.keyPath) return store.put(value);
if(store.keyPath) return store.put(value);
return store.put(value, key);
});
}

View File

@ -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]}))

View File

@ -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.
*

View File

@ -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
*

View File

@ -325,10 +325,13 @@ export class PathEventEmitter implements IPathEventEmitter{
}
on(event: Event | Event[], listener: PathListener): PathUnsubscribe {
makeArray(event).forEach(e => this.listeners.push([
e instanceof PathEvent ? e : 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);
}

View File

@ -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]));

View File

@ -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
*

View File

@ -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);
});
});
});