Compare commits

...

4 Commits

Author SHA1 Message Date
0f10aebfd2 bubble up all fetch errors in the http helper
All checks were successful
Build / Build NPM Project (push) Successful in 40s
Build / Tag Version (push) Successful in 8s
Build / Publish Documentation (push) Successful in 36s
2024-10-14 20:46:32 -04:00
1af23ac544 Fixed cache localstorage
All checks were successful
Build / Build NPM Project (push) Successful in 37s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 34s
2024-10-14 20:04:29 -04:00
494cfaaccd Added localStorage support to cache
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 41s
2024-10-14 18:51:24 -04:00
23df6ad265 Renamed PathEventEmitter to follow convention
All checks were successful
Build / Build NPM Project (push) Successful in 27s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 27s
2024-10-14 14:09:51 -04:00
6 changed files with 95 additions and 5825 deletions

5753
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,6 +1,6 @@
{ {
"name": "@ztimson/utils", "name": "@ztimson/utils",
"version": "0.19.1", "version": "0.20.2",
"description": "Utility library", "description": "Utility library",
"author": "Zak Timson", "author": "Zak Timson",
"license": "MIT", "license": "MIT",
@ -38,8 +38,5 @@
}, },
"files": [ "files": [
"dist" "dist"
], ]
"dependencies": {
"var-persist": "^1.0.1"
}
} }

View File

@ -1,3 +1,12 @@
export type CacheOptions = {
/** Delete keys automatically after x amount of seconds */
ttl?: number;
/** Storage to persist cache */
storage?: Storage;
/** Key cache will be stored under */
storageKey?: string;
}
/** /**
* Map of data which tracks whether it is a complete collection & offers optional expiry of cached values * Map of data which tracks whether it is a complete collection & offers optional expiry of cached values
*/ */
@ -13,9 +22,18 @@ export class Cache<K extends string | number | symbol, T> {
* Create new cache * Create new cache
* *
* @param {keyof T} key Default property to use as primary key * @param {keyof T} key Default property to use as primary key
* @param {number} ttl Default expiry in milliseconds * @param options
*/ */
constructor(public readonly key?: keyof T, public ttl?: number) { constructor(public readonly key?: keyof T, public readonly options: CacheOptions = {}) {
if(options.storageKey && !options.storage)
options.storage = localStorage;
if(options.storageKey && options.storage) {
const stored = options.storage.getItem(options.storageKey);
if(stored) {
try { Object.assign(this.store, JSON.parse(stored)); }
catch { }
}
}
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];
@ -76,6 +94,8 @@ export class Cache<K extends string | number | symbol, T> {
*/ */
delete(key: K) { delete(key: K) {
delete this.store[key]; delete this.store[key];
if(this.options.storageKey && this.options.storage)
this.options.storage.setItem(this.options.storageKey, JSON.stringify(this.store));
} }
/** /**
@ -118,15 +138,17 @@ export class Cache<K extends string | number | symbol, T> {
* *
* @param {K} key Key item will be cached under * @param {K} key Key item will be cached under
* @param {T} value Item to cache * @param {T} value Item to cache
* @param {number | undefined} ttl Override default expiry * @param {number | undefined} ttl Override default expiry in seconds
* @return {this} * @return {this}
*/ */
set(key: K, value: T, ttl = this.ttl): this { set(key: K, value: T, ttl = this.options.ttl): this {
this.store[key] = value; this.store[key] = value;
if(this.options.storageKey && this.options.storage)
this.options.storage.setItem(this.options.storageKey, JSON.stringify(this.store));
if(ttl) setTimeout(() => { if(ttl) setTimeout(() => {
this.complete = false; this.complete = false;
this.delete(key); this.delete(key);
}, ttl); }, ttl * 1000);
return this; return this;
} }

View File

@ -75,6 +75,7 @@ export class Http {
// Send request // Send request
return new PromiseProgress((res, rej, prog) => { return new PromiseProgress((res, rej, prog) => {
try {
fetch(url, { fetch(url, {
headers, headers,
method: opts.method || (opts.body ? 'POST' : 'GET'), method: opts.method || (opts.body ? 'POST' : 'GET'),
@ -100,6 +101,7 @@ export class Http {
push(); push();
}).catch((error: any) => controller.error(error)); }).catch((error: any) => controller.error(error));
} }
push(); push();
} }
}); });
@ -115,7 +117,10 @@ export class Http {
if(resp.ok) res(resp); if(resp.ok) res(resp);
else rej(resp); else rej(resp);
}) }).catch(err => rej(err));
} catch(err) {
rej(err);
}
}); });
} }
} }

View File

@ -16,4 +16,3 @@ export * from './promise-progress';
export * from './string'; export * from './string';
export * from './time'; export * from './time';
export * from './types'; export * from './types';
export * from 'var-persist';

View File

@ -14,16 +14,16 @@ import {ASet} from './aset.ts';
export type Method = '*' | 'n' | 'c' | 'r' | 'u' | 'd' | 'x'; export type Method = '*' | 'n' | 'c' | 'r' | 'u' | 'd' | 'x';
/** /**
* Shorthand for creating PathedEvent from a string * Shorthand for creating Event from a string
* *
* @example * @example
* ```ts * ```ts
* const event: PathedEvent = PE`users/system:*`; * const event: Event = PE`users/system:*`;
* ``` * ```
* *
* @param {TemplateStringsArray} str String that will be parsed into PathedEvent * @param {TemplateStringsArray} str String that will be parsed into Event
* @param {string} args * @param {string} args
* @return {PathEvent} PathedEvent object * @return {PathEvent} Event object
*/ */
export function PE(str: TemplateStringsArray, ...args: string[]) { export function PE(str: TemplateStringsArray, ...args: string[]) {
const combined = []; const combined = [];
@ -35,7 +35,7 @@ export function PE(str: TemplateStringsArray, ...args: string[]) {
} }
/** /**
* Shorthand for creating PathedEvent strings, ensures paths are correct * Shorthand for creating Event strings, ensures paths are correct
* *
* @param {TemplateStringsArray} str * @param {TemplateStringsArray} str
* @param {string} args * @param {string} args
@ -53,8 +53,8 @@ export function PES(str: TemplateStringsArray, ...args: any[]) {
} }
/** /**
* A pathed event broken down into its core components for easy processing * A event broken down into its core components for easy processing
* PathedEvent Structure: `module/path/name:property:method` * Event Structure: `module/path/name:property:method`
* Example: `users/system:crud` or `storage/some/path/file.txt:r` * Example: `users/system:crud` or `storage/some/path/file.txt:r`
*/ */
export class PathEvent { export class PathEvent {
@ -81,9 +81,9 @@ export class PathEvent {
/** Delete method specified */ /** Delete method specified */
delete!: boolean; delete!: boolean;
constructor(pathedEvent: string | PathEvent) { constructor(Event: string | PathEvent) {
if(typeof pathedEvent == 'object') return Object.assign(this, pathedEvent); if(typeof Event == 'object') return Object.assign(this, Event);
let [p, scope, method] = pathedEvent.split(':'); let [p, scope, method] = Event.split(':');
if(!method) method = scope || '*'; if(!method) method = scope || '*';
if(p == '*' || !p && method == '*') { if(p == '*' || !p && method == '*') {
p = ''; p = '';
@ -104,10 +104,10 @@ export class PathEvent {
} }
/** /**
* Combine multiple pathed events into one parsed object. Longest path takes precedent, but all subsequent methods are * Combine multiple events into one parsed object. Longest path takes precedent, but all subsequent methods are
* combined until a "none" is reached * combined until a "none" is reached
* *
* @param {string | PathEvent} paths PathedEvents as strings or pre-parsed * @param {string | PathEvent} paths Events as strings or pre-parsed
* @return {PathEvent} Final combined permission * @return {PathEvent} Final combined permission
*/ */
static combine(paths: (string | PathEvent)[]): PathEvent { static combine(paths: (string | PathEvent)[]): PathEvent {
@ -138,7 +138,7 @@ export class PathEvent {
/** /**
* Squash 2 sets of paths & return true if any overlap is found * Squash 2 sets of paths & return true if any overlap is found
* *
* @param {string | PathEvent | (string | PathEvent)[]} target Array of PathedEvents as strings or pre-parsed * @param {string | PathEvent | (string | PathEvent)[]} target Array of Events as strings or pre-parsed
* @param has Target must have at least one of these path * @param has Target must have at least one of these path
* @return {boolean} Whether there is any overlap * @return {boolean} Whether there is any overlap
*/ */
@ -157,7 +157,7 @@ export class PathEvent {
/** /**
* Squash 2 sets of paths & return true if the target has all paths * Squash 2 sets of paths & return true if the target has all paths
* *
* @param {string | PathEvent | (string | PathEvent)[]} target Array of PathedEvents as strings or pre-parsed * @param {string | PathEvent | (string | PathEvent)[]} target Array of Events as strings or pre-parsed
* @param has Target must have all these paths * @param has Target must have all these paths
* @return {boolean} Whether there is any overlap * @return {boolean} Whether there is any overlap
*/ */
@ -168,7 +168,7 @@ export class PathEvent {
/** /**
* Same as `has` but raises an error if there is no overlap * Same as `has` but raises an error if there is no overlap
* *
* @param {string | string[]} target Array of PathedEvents as strings or pre-parsed * @param {string | string[]} target Array of Events as strings or pre-parsed
* @param has Target must have at least one of these path * @param has Target must have at least one of these path
*/ */
static hasFatal(target: string | PathEvent | (string | PathEvent)[], ...has: (string | PathEvent)[]): void { static hasFatal(target: string | PathEvent | (string | PathEvent)[], ...has: (string | PathEvent)[]): void {
@ -178,7 +178,7 @@ export class PathEvent {
/** /**
* Same as `hasAll` but raises an error if the target is missing any paths * Same as `hasAll` but raises an error if the target is missing any paths
* *
* @param {string | string[]} target Array of PathedEvents as strings or pre-parsed * @param {string | string[]} target Array of Events as strings or pre-parsed
* @param has Target must have all these paths * @param has Target must have all these paths
*/ */
static hasAllFatal(target: string | PathEvent | (string | PathEvent)[], ...has: (string | PathEvent)[]): void { static hasAllFatal(target: string | PathEvent | (string | PathEvent)[], ...has: (string | PathEvent)[]): void {
@ -186,11 +186,11 @@ export class PathEvent {
} }
/** /**
* Create pathed event string from its components * Create event string from its components
* *
* @param {string | string[]} path Event path * @param {string | string[]} path Event path
* @param {Method} methods Event method * @param {Method} methods Event method
* @return {string} String representation of PathedEvent * @return {string} String representation of Event
*/ */
static toString(path: string | string[], methods: Method | Method[]): string { static toString(path: string | string[], methods: Method | Method[]): string {
let p = makeArray(path).filter(p => p != null).join('/'); let p = makeArray(path).filter(p => p != null).join('/');
@ -199,9 +199,9 @@ export class PathEvent {
} }
/** /**
* Create pathed event string from its components * Create event string from its components
* *
* @return {string} String representation of PathedEvent * @return {string} String representation of Event
*/ */
toString() { toString() {
return PathEvent.toString(this.fullPath, this.methods); return PathEvent.toString(this.fullPath, this.methods);
@ -211,7 +211,7 @@ export class PathEvent {
export type PathListener = (event: PathEvent, ...args: any[]) => any; export type PathListener = (event: PathEvent, ...args: any[]) => any;
export type PathUnsubscribe = () => void; export type PathUnsubscribe = () => void;
export interface IPathedEventEmitter { export interface IPathEventEmitter {
emit(event: string, ...args: any[]): void; emit(event: string, ...args: any[]): void;
off(listener: PathListener): void; off(listener: PathListener): void;
on(event: string, listener: PathListener): PathUnsubscribe; on(event: string, listener: PathListener): PathUnsubscribe;
@ -222,7 +222,7 @@ export interface IPathedEventEmitter {
/** /**
* Event emitter that uses paths allowing listeners to listen to different combinations of modules, paths & methods * Event emitter that uses paths allowing listeners to listen to different combinations of modules, paths & methods
*/ */
export class PathEventEmitter implements IPathedEventEmitter{ export class PathEventEmitter implements IPathEventEmitter{
private listeners: [PathEvent, PathListener][] = []; private listeners: [PathEvent, PathListener][] = [];
emit(event: string | PathEvent, ...args: any[]) { emit(event: string | PathEvent, ...args: any[]) {
@ -250,7 +250,7 @@ export class PathEventEmitter implements IPathedEventEmitter{
}); });
} }
relayEvents(emitter: IPathedEventEmitter) { relayEvents(emitter: IPathEventEmitter) {
emitter.on('*', (event, ...args) => this.emit(event, ...args)); emitter.on('*', (event, ...args) => this.emit(event, ...args));
} }
} }