Compare commits

..

13 Commits

Author SHA1 Message Date
10ac6101f4 Fixed cache handling of undefined
All checks were successful
Build / Build NPM Project (push) Successful in 47s
Build / Tag Version (push) Successful in 13s
Build / Publish Documentation (push) Successful in 53s
2025-06-30 11:44:32 -04:00
b5d534dc8c Added hook to wait for cache loading
All checks were successful
Build / Build NPM Project (push) Successful in 39s
Build / Tag Version (push) Successful in 8s
Build / Publish Documentation (push) Successful in 34s
2025-06-29 23:11:21 -04:00
d140b2edd1 Revert: Restoring cache from DB gets complete status
All checks were successful
Build / Build NPM Project (push) Successful in 41s
Build / Tag Version (push) Successful in 8s
Build / Publish Documentation (push) Successful in 32s
2025-06-29 22:41:39 -04:00
56f6681492 Restoring cache from DB gets complete status
All checks were successful
Build / Build NPM Project (push) Successful in 47s
Build / Tag Version (push) Successful in 15s
Build / Publish Documentation (push) Successful in 52s
2025-06-29 22:29:16 -04:00
64945a647c Fixed path-events
All checks were successful
Build / Build NPM Project (push) Successful in 43s
Build / Tag Version (push) Successful in 8s
Build / Publish Documentation (push) Successful in 48s
2025-06-28 22:25:11 -04:00
adafd61c83 Added IPv6 to v4 converter
All checks were successful
Build / Build NPM Project (push) Successful in 1m17s
Build / Tag Version (push) Successful in 14s
Build / Publish Documentation (push) Successful in 52s
2025-06-25 11:48:49 -04:00
7747dc5558 more path event fixes.... i hope...
All checks were successful
Build / Build NPM Project (push) Successful in 43s
Build / Tag Version (push) Successful in 8s
Build / Publish Documentation (push) Successful in 36s
2025-06-24 22:21:34 -04:00
947bdbc6d4 more path event fixes.... i hope...
Some checks failed
Build / Tag Version (push) Has been cancelled
Build / Publish Documentation (push) Has been cancelled
Build / Build NPM Project (push) Has been cancelled
2025-06-24 22:21:30 -04:00
e2b8c35535 more path event fixes.... i hope...
All checks were successful
Build / Build NPM Project (push) Successful in 44s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 37s
2025-06-24 22:05:39 -04:00
3b7d28de4b Fixed test
Some checks failed
Build / Build NPM Project (push) Failing after 39s
Build / Publish Documentation (push) Has been skipped
Build / Tag Version (push) Has been skipped
2025-06-24 20:55:12 -04:00
8f7e816571 path event fixes
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-06-24 20:52:16 -04:00
8c1fb2d8cb Fixed filename timestamp
All checks were successful
Build / Build NPM Project (push) Successful in 1m20s
Build / Tag Version (push) Successful in 15s
Build / Publish Documentation (push) Successful in 56s
2025-06-23 18:08:25 -04:00
91dc17667e Better cache & database integration
All checks were successful
Build / Build NPM Project (push) Successful in 44s
Build / Tag Version (push) Successful in 13s
Build / Publish Documentation (push) Successful in 51s
2025-06-20 19:41:01 -04:00
6 changed files with 102 additions and 35 deletions

View File

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

View File

@ -24,6 +24,8 @@ export class Cache<K extends string | number | symbol, T> {
[key: string | number | symbol]: CachedValue<T> | any;
/** Whether cache is complete */
complete = false;
/** Await initial loading */
loading!: Promise<void>;
/**
* Create new cache
@ -31,15 +33,21 @@ 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) {
(async () => (await options.storage?.getAll()).forEach((v: any) => this.add(v)))()
(async () => {
this.addAll(await options.storage?.getAll(), false);
resolve();
})()
} else if(options.storageKey) {
const stored = options.storage?.getItem(options.storageKey);
if(stored != null) try { Object.assign(this.store, JSON.parse(stored)); } catch { }
resolve();
}
}
} else resolve();
return new Proxy(this, {
get: (target: this, prop: string | symbol) => {
if(prop in target) return (target as any)[prop];
@ -55,13 +63,22 @@ export class Cache<K extends string | number | symbol, T> {
private getKey(value: T): K {
if(!this.key) throw new Error('No key defined');
if(value[this.key] === undefined) throw new Error(`${this.key.toString()} Doesn't exist on ${JSON.stringify(value, null, 2)}`);
return <K>value[this.key];
}
private save(key: K) {
private save(key?: K) {
if(this.options.storage) {
if(this.options.storage instanceof Table) {
this.options.storage.put(key, this.store[key]);
if(key == null) {
const rows = this.entries();
rows.forEach(([k, v]) => this.options.storage?.put(k, v));
this.options.storage.getAllKeys().then(keys => {
rows.map(([k]) => k).filter(k => !keys.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));
}
@ -108,6 +125,7 @@ export class Cache<K extends string | number | symbol, T> {
clear(): this {
this.complete = false;
this.store = <any>{};
this.save();
return this;
}

View File

@ -77,7 +77,7 @@ export function fileText(file: any): Promise<string | null> {
*/
export function timestampFilename(name?: string, date: Date | number | string = new Date()) {
if(typeof date == 'number' || typeof date == 'string') date = new Date(date);
const timestamp = formatDate('YYYY-MM-DD_HH:mm:ss', date);
const timestamp = formatDate('YYYY-MM-DD_HH-mm', date);
return name ? name.replace('{{TIMESTAMP}}', timestamp) : timestamp;
}

View File

@ -1,6 +1,16 @@
import {PathEvent} from './path-events.ts';
import {md5} from './string';
/**
* Escape any regex special characters to avoid misinterpretation during search
*
* @param {string} value String which should be escaped
* @return {string} New escaped sequence
*/
export function escapeRegex(value: string) {
return value.replace(/[.*+?^${}()|\[\]\\]/g, '\\$&');
}
/**
* Run a stringified function with arguments asynchronously
* @param {object} args Map of key/value arguments
@ -26,13 +36,15 @@ export function gravatar(email: string, def='mp') {
}
/**
* Escape any regex special characters to avoid misinterpretation during search
*
* @param {string} value String which should be escaped
* @return {string} New escaped sequence
* Convert IPv6 to v4 because who uses that, NAT4Life
* @param {string} ip IPv6 address, e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334
* @returns {string | null} IPv4 address, e.g. 172.16.58.3
*/
export function escapeRegex(value: string) {
return value.replace(/[.*+?^${}()|\[\]\\]/g, '\\$&');
export function ipV6ToV4(ip: string) {
if(!ip) return null;
const ipv4 = ip.split(':').splice(-1)[0];
if(ipv4 == '1') return '127.0.0.1';
return ipv4;
}
/**

View File

@ -99,7 +99,7 @@ export class PathEvent {
method = '*';
}
let temp = p.split('/').filter(p => !!p);
this.module = temp.splice(0, 1)[0]?.toLowerCase() || '';
this.module = temp.splice(0, 1)[0] || '';
this.path = temp.join('/');
this.fullPath = `${this.module}${this.module && this.path ? '/' : ''}${this.path}`;
this.name = temp.pop() || '';
@ -140,13 +140,14 @@ export class PathEvent {
*/
static filter(target: string | PathEvent | (string | PathEvent)[], ...filter: (string | PathEvent)[]): PathEvent[] {
const parsedTarget = makeArray(target).map(pe => new PathEvent(pe));
const parsedFind = makeArray(filter).map(pe => new PathEvent(pe));
return parsedTarget.filter(t => {
if(!t.fullPath && t.all) return true;
return !!parsedFind.find(f =>
(t.fullPath.startsWith(f.fullPath) || f.fullPath.startsWith(t.fullPath)) &&
(f.all || t.all || t.methods.intersection(f.methods).length));
});
const parsedFilter = makeArray(filter).map(pe => new PathEvent(pe));
return parsedTarget.filter(t => !!parsedFilter.find(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 scope = p1.startsWith(p2) || p2.startsWith(p1);
const methods = r.all || t.all || r.methods.intersection(t.methods).length;
return (wildcard || scope) && methods;
}));
}
/**
@ -157,15 +158,15 @@ export class PathEvent {
* @return {boolean} Whether there is any overlap
*/
static has(target: string | PathEvent | (string | PathEvent)[], ...has: (string | PathEvent)[]): boolean {
const parsedRequired = makeArray(has).map(pe => new PathEvent(pe));
const parsedTarget = makeArray(target).map(pe => new PathEvent(pe));
return !!parsedRequired.find(r => {
if(!r.fullPath && r.all) return true;
const filtered = parsedTarget.filter(p => r.fullPath.startsWith(p.fullPath));
if(!filtered.length) return false;
const combined = PathEvent.combine(...filtered);
return (!combined.none && (combined.all || r.all)) || combined.methods.intersection(r.methods).length;
});
const parsedRequired = makeArray(has).map(pe => new PathEvent(pe));
return !!parsedRequired.find(r => !!parsedTarget.find(t => {
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 methods = r.all || t.all || r.methods.intersection(t.methods).length;
return (wildcard || scope) && methods;
}));
}
/**
@ -213,6 +214,44 @@ export class PathEvent {
return p;
}
/**
* Squash 2 sets of paths & return true if any overlap is found
*
* @param has Target must have at least one of these path
* @return {boolean} Whether there is any overlap
*/
has(...has: (string | PathEvent)[]): boolean {
return PathEvent.has(this, ...has);
}
/**
* Squash 2 sets of paths & return true if the target has all paths
*
* @param has Target must have all these paths
* @return {boolean} Whether there is any overlap
*/
hasAll(...has: (string | PathEvent)[]): boolean {
return PathEvent.hasAll(this, ...has);
}
/**
* Same as `has` but raises an error if there is no overlap
*
* @param has Target must have at least one of these path
*/
hasFatal(...has: (string | PathEvent)[]): void {
return PathEvent.hasFatal(this, ...has);
}
/**
* Same as `hasAll` but raises an error if the target is missing any paths
*
* @param has Target must have all these paths
*/
hasAllFatal(...has: (string | PathEvent)[]): void {
return PathEvent.hasAllFatal(this, ...has);
}
/**
* Filter a set of paths based on this event
*
@ -265,7 +304,7 @@ export class PathEventEmitter implements IPathEventEmitter{
on(event: Event | Event[], listener: PathListener): PathUnsubscribe {
makeArray(event).forEach(e => this.listeners.push([
new PathEvent(`${this.prefix}/${new PathEvent(e).toString()}`),
new PathEvent(`${this.prefix}/${e}`),
listener
]));
return () => this.off(listener);

View File

@ -27,7 +27,7 @@ describe('Path Events', () => {
describe('PathEvent', () => {
it('parses event string', () => {
const pe = new PathEvent('Users/system:cr');
const pe = new PathEvent('users/system:cr');
expect(pe.module).toBe('users');
expect(pe.fullPath).toBe('users/system');
expect(pe.name).toBe('system');
@ -103,11 +103,9 @@ describe('Path Events', () => {
});
it('has returns true for overlapping', () => {
const events = [
new PathEvent('users/sys:cr'),
];
expect(PathEvent.has(events, 'users/sys:r')).toBe(true);
expect(PathEvent.has(events, 'users/nope:r')).toBe(false);
const events = [new PathEvent('users/sys:cr')];
expect(PathEvent.has(events, 'users/sys:r')).toBeTruthy();
expect(PathEvent.has(events, 'users/nope:r')).toBeFalsy();
});
it('hasAll returns true only if all overlap', () => {