Compare commits

...

9 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
6 changed files with 129 additions and 46 deletions

View File

@ -1,6 +1,6 @@
{
"name": "@ztimson/utils",
"version": "0.26.17",
"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,9 +33,6 @@ 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')
@ -45,13 +44,15 @@ export class Cache<K extends string | number | symbol, T> {
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((<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

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

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

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

@ -45,20 +45,20 @@ export function formatBytes(bytes: number, decimals = 2) {
/**
* Convert milliseconds to human-readable duration
* @param {string} number milliseconds
* @param {string} ms milliseconds
* @param {boolean} short Use unit initial instead of word
* @return {string} formated duration
*/
export function formatMs(number: string): string {
const ms = parseInt(number, 10);
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)} days`;
else if (hours >= 1) return `${hours.toFixed(1)} hours`;
else if (minutes >= 1) return `${minutes.toFixed(1)} minutes`;
else return `${seconds.toFixed(1)} seconds`;
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'}`;
}
/**