Compare commits
22 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| b292d5ed17 | |||
| a1ea8cdf67 | |||
| fbbe3c99ef | |||
| 1c1a3f6a6e | |||
| 2dce1ad9ac | |||
| cebfd2c508 | |||
| 7c5cf3535d | |||
| 847b493772 | |||
| b1005227ab | |||
| 3a389de72e | |||
| 151465aa65 | |||
| b103b6f786 | |||
| 3b486310de | |||
| 8699fb49ff | |||
| fdb29e7984 | |||
| 274c22bb83 | |||
| b21f462d35 | |||
| 0f10aebfd2 | |||
| 1af23ac544 | |||
| 494cfaaccd | |||
| 23df6ad265 | |||
| 2fda11f3b7 |
12
.npmignore
Normal file
12
.npmignore
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
src
|
||||||
|
tests
|
||||||
|
.editorconfig
|
||||||
|
.gitignore
|
||||||
|
.gitmodules
|
||||||
|
.npmignore
|
||||||
|
CODEOWNERS
|
||||||
|
Dockerfile
|
||||||
|
index.html
|
||||||
|
jest.config.js
|
||||||
|
tsconfig.json
|
||||||
|
vite.config.js
|
||||||
14
index.html
Normal file
14
index.html
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
<!Doctype html>
|
||||||
|
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<title>@ztimson/utils sandbox</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<script type="module">
|
||||||
|
import {PathEvent} from './dist/index.mjs';
|
||||||
|
|
||||||
|
console.log(PathEvent.has(['data/Inventory:n', 'logs:c'], `logs/client:n`));
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
5753
package-lock.json
generated
5753
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@ztimson/utils",
|
"name": "@ztimson/utils",
|
||||||
"version": "0.19.0",
|
"version": "0.21.5",
|
||||||
"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"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
17
src/aset.ts
17
src/aset.ts
@ -1,3 +1,5 @@
|
|||||||
|
import {isEqual} from './objects.ts';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* An array which functions as a set. It guarantees unique elements
|
* An array which functions as a set. It guarantees unique elements
|
||||||
* and provides set functions for comparisons
|
* and provides set functions for comparisons
|
||||||
@ -24,6 +26,7 @@ export class ASet<T> extends Array {
|
|||||||
*/
|
*/
|
||||||
add(...items: T[]) {
|
add(...items: T[]) {
|
||||||
items.filter(el => !this.has(el)).forEach(el => this.push(el));
|
items.filter(el => !this.has(el)).forEach(el => this.push(el));
|
||||||
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -33,8 +36,9 @@ export class ASet<T> extends Array {
|
|||||||
delete(...items: T[]) {
|
delete(...items: T[]) {
|
||||||
items.forEach(el => {
|
items.forEach(el => {
|
||||||
const index = this.indexOf(el);
|
const index = this.indexOf(el);
|
||||||
if(index != -1) this.slice(index, 1);
|
if(index != -1) this.splice(index, 1);
|
||||||
})
|
})
|
||||||
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -55,6 +59,17 @@ export class ASet<T> extends Array {
|
|||||||
return this.indexOf(el) != -1;
|
return this.indexOf(el) != -1;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Find index number of element, or -1 if it doesn't exist. Matches by equality not reference
|
||||||
|
*
|
||||||
|
* @param {T} search Element to find
|
||||||
|
* @param {number} fromIndex Starting index position
|
||||||
|
* @return {number} Element index number or -1 if missing
|
||||||
|
*/
|
||||||
|
indexOf(search: T, fromIndex?: number): number {
|
||||||
|
return super.findIndex((el: T) => isEqual(el, search), fromIndex);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create list of elements this set has in common with the comparison set
|
* Create list of elements this set has in common with the comparison set
|
||||||
* @param {ASet<T>} set Set to compare against
|
* @param {ASet<T>} set Set to compare against
|
||||||
|
|||||||
39
src/cache.ts
39
src/cache.ts
@ -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 && typeof(Storage) !== 'undefined')
|
||||||
|
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];
|
||||||
@ -69,6 +87,13 @@ export class Cache<K extends string | number | symbol, T> {
|
|||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove all keys from cache
|
||||||
|
*/
|
||||||
|
clear() {
|
||||||
|
this.store = <Record<K, T>>{};
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete an item from the cache
|
* Delete an item from the cache
|
||||||
*
|
*
|
||||||
@ -76,6 +101,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 +145,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;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@ -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);
|
||||||
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -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';
|
|
||||||
|
|||||||
@ -1,4 +1,5 @@
|
|||||||
import {TypedEmitter, TypedEvents} from './emitter';
|
import {TypedEmitter, TypedEvents} from './emitter';
|
||||||
|
import {JSONSanitize} from './objects.ts';
|
||||||
|
|
||||||
export const CliEffects = {
|
export const CliEffects = {
|
||||||
CLEAR: "\x1b[0m",
|
CLEAR: "\x1b[0m",
|
||||||
@ -64,49 +65,41 @@ export class Logger extends TypedEmitter<LoggerEvents> {
|
|||||||
super();
|
super();
|
||||||
}
|
}
|
||||||
|
|
||||||
private pad(text: any, length: number, char: string, end = false) {
|
protected format(...text: any[]): string {
|
||||||
const t = text.toString();
|
|
||||||
const l = length - t.length;
|
|
||||||
if(l <= 0) return t;
|
|
||||||
const padding = Array(~~(l / char.length)).fill(char).join('');
|
|
||||||
return !end ? padding + t : t + padding;
|
|
||||||
}
|
|
||||||
|
|
||||||
private format(...text: string[]): string {
|
|
||||||
const now = new Date();
|
const now = new Date();
|
||||||
const timestamp = `${now.getFullYear()}-${now.getMonth() + 1}-${now.getDate()} ${this.pad(now.getHours().toString(), 2, '0')}:${this.pad(now.getMinutes().toString(), 2, '0')}:${this.pad(now.getSeconds().toString(), 2, '0')}.${this.pad(now.getMilliseconds().toString(), 3, '0', true)}`;
|
const timestamp = `${now.getFullYear()}-${now.getMonth() + 1}-${now.getDate()} ${now.getHours().toString().padStart(2, '0')}:${now.getMinutes().toString().padStart(2, '0')}:${now.getSeconds().toString().padStart(2, '0')}.${now.getMilliseconds().toString().padEnd(3, '0')}`;
|
||||||
return `${timestamp}${this.namespace ? ` [${this.namespace}]` : ''} ${text.join(' ')}`;
|
return `${timestamp}${this.namespace ? ` [${this.namespace}]` : ''} ${text.map(t => typeof t == 'string' ? t : JSONSanitize(t, 2)).join(' ')}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
debug(...args: string[]) {
|
debug(...args: any[]) {
|
||||||
if(Logger.LOG_LEVEL < LOG_LEVEL.DEBUG) return;
|
if(Logger.LOG_LEVEL < LOG_LEVEL.DEBUG) return;
|
||||||
const str = this.format(...args);
|
const str = this.format(...args);
|
||||||
Logger.emit(LOG_LEVEL.DEBUG, str);
|
Logger.emit(LOG_LEVEL.DEBUG, str);
|
||||||
console.debug(CliForeground.LIGHT_GREY + str + CliEffects.CLEAR);
|
console.debug(CliForeground.LIGHT_GREY + str + CliEffects.CLEAR);
|
||||||
}
|
}
|
||||||
|
|
||||||
log(...args: string[]) {
|
log(...args: any[]) {
|
||||||
if(Logger.LOG_LEVEL < LOG_LEVEL.LOG) return;
|
if(Logger.LOG_LEVEL < LOG_LEVEL.LOG) return;
|
||||||
const str = this.format(...args);
|
const str = this.format(...args);
|
||||||
Logger.emit(LOG_LEVEL.LOG, str);
|
Logger.emit(LOG_LEVEL.LOG, str);
|
||||||
console.log(CliEffects.CLEAR + str);
|
console.log(CliEffects.CLEAR + str);
|
||||||
}
|
}
|
||||||
|
|
||||||
info(...args: string[]) {
|
info(...args: any[]) {
|
||||||
if(Logger.LOG_LEVEL < LOG_LEVEL.INFO) return;
|
if(Logger.LOG_LEVEL < LOG_LEVEL.INFO) return;
|
||||||
const str = this.format(...args);
|
const str = this.format(...args);
|
||||||
Logger.emit(LOG_LEVEL.INFO, str);
|
Logger.emit(LOG_LEVEL.INFO, str);
|
||||||
console.info(CliForeground.BLUE + str + CliEffects.CLEAR);
|
console.info(CliForeground.BLUE + str + CliEffects.CLEAR);
|
||||||
}
|
}
|
||||||
|
|
||||||
warn(...args: string[]) {
|
warn(...args: any[]) {
|
||||||
if(Logger.LOG_LEVEL < LOG_LEVEL.WARN) return;
|
if(Logger.LOG_LEVEL < LOG_LEVEL.WARN) return;
|
||||||
const str = this.format(...args);
|
const str = this.format(...args);
|
||||||
Logger.emit(LOG_LEVEL.WARN, str);
|
Logger.emit(LOG_LEVEL.WARN, str);
|
||||||
console.warn(CliForeground.YELLOW + str + CliEffects.CLEAR);
|
console.warn(CliForeground.YELLOW + str + CliEffects.CLEAR);
|
||||||
}
|
}
|
||||||
|
|
||||||
error(...args: string[]) {
|
error(...args: any[]) {
|
||||||
if(Logger.LOG_LEVEL < LOG_LEVEL.ERROR) return;
|
if(Logger.LOG_LEVEL < LOG_LEVEL.ERROR) return;
|
||||||
const str = this.format(...args);
|
const str = this.format(...args);
|
||||||
Logger.emit(LOG_LEVEL.ERROR, str);
|
Logger.emit(LOG_LEVEL.ERROR, str);
|
||||||
|
|||||||
@ -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
|
||||||
@ -52,9 +52,11 @@ export function PES(str: TemplateStringsArray, ...args: any[]) {
|
|||||||
return PathEvent.toString(paths, <any>methods?.split(''));
|
return PathEvent.toString(paths, <any>methods?.split(''));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export class PathError extends Error { }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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 {
|
||||||
@ -67,23 +69,30 @@ export class PathEvent {
|
|||||||
/** Last sagment of path */
|
/** Last sagment of path */
|
||||||
name!: string;
|
name!: string;
|
||||||
/** List of methods */
|
/** List of methods */
|
||||||
methods!: Method[];
|
methods!: ASet<Method>;
|
||||||
/** All/Wildcard specified */
|
|
||||||
all!: boolean;
|
|
||||||
/** None specified */
|
|
||||||
none!: boolean;
|
|
||||||
/** Create method specified */
|
|
||||||
create!: boolean;
|
|
||||||
/** Read method specified */
|
|
||||||
read!: boolean;
|
|
||||||
/** Update method specified */
|
|
||||||
update!: boolean;
|
|
||||||
/** Delete method specified */
|
|
||||||
delete!: boolean;
|
|
||||||
|
|
||||||
constructor(pathedEvent: string | PathEvent) {
|
/** All/Wildcard specified */
|
||||||
if(typeof pathedEvent == 'object') return Object.assign(this, pathedEvent);
|
get all(): boolean { return this.methods.has('*') }
|
||||||
let [p, scope, method] = pathedEvent.split(':');
|
set all(v: boolean) { v ? 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'); }
|
||||||
|
/** Create method specified */
|
||||||
|
get create(): boolean { return !this.methods.has('n') && (this.methods.has('*') || this.methods.has('c')) }
|
||||||
|
set create(v: boolean) { v ? this.methods.delete('n').add('c') : this.methods.delete('c'); }
|
||||||
|
/** Read method specified */
|
||||||
|
get read(): boolean { return !this.methods.has('n') && (this.methods.has('*') || this.methods.has('r')) }
|
||||||
|
set read(v: boolean) { v ? this.methods.delete('n').add('r') : this.methods.delete('r'); }
|
||||||
|
/** Update method specified */
|
||||||
|
get update(): boolean { return !this.methods.has('n') && (this.methods.has('*') || this.methods.has('u')) }
|
||||||
|
set update(v: boolean) { v ? this.methods.delete('n').add('u') : this.methods.delete('u'); }
|
||||||
|
/** Delete method specified */
|
||||||
|
get delete(): boolean { return !this.methods.has('n') && (this.methods.has('*') || this.methods.has('d')) }
|
||||||
|
set delete(v: boolean) { v ? this.methods.delete('n').add('d') : this.methods.delete('d'); }
|
||||||
|
|
||||||
|
constructor(Event: string | PathEvent) {
|
||||||
|
if(typeof Event == 'object') return Object.assign(this, Event);
|
||||||
|
let [p, scope, method] = Event.split(':');
|
||||||
if(!method) method = scope || '*';
|
if(!method) method = scope || '*';
|
||||||
if(p == '*' || !p && method == '*') {
|
if(p == '*' || !p && method == '*') {
|
||||||
p = '';
|
p = '';
|
||||||
@ -94,23 +103,17 @@ export class PathEvent {
|
|||||||
this.fullPath = p;
|
this.fullPath = p;
|
||||||
this.path = temp.join('/');
|
this.path = temp.join('/');
|
||||||
this.name = temp.pop() || '';
|
this.name = temp.pop() || '';
|
||||||
this.methods = <Method[]>method.split('');
|
this.methods = new ASet(<any>method.split(''));
|
||||||
this.all = method?.includes('*');
|
|
||||||
this.none = method?.includes('n');
|
|
||||||
this.create = !method?.includes('n') && (method?.includes('*') || method?.includes('w') || method?.includes('c'));
|
|
||||||
this.read = !method?.includes('n') && (method?.includes('*') || method?.includes('r'));
|
|
||||||
this.update = !method?.includes('n') && (method?.includes('*') || method?.includes('w') || method?.includes('u'));
|
|
||||||
this.delete = !method?.includes('n') && (method?.includes('*') || method?.includes('w') || method?.includes('d'));
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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 {
|
||||||
let hitNone = false;
|
let hitNone = false;
|
||||||
const combined = paths.map(p => new PathEvent(p))
|
const combined = paths.map(p => new PathEvent(p))
|
||||||
.toSorted((p1, p2) => {
|
.toSorted((p1, p2) => {
|
||||||
@ -120,25 +123,34 @@ export class PathEvent {
|
|||||||
if(p.none) hitNone = true;
|
if(p.none) hitNone = true;
|
||||||
if(!acc) return p;
|
if(!acc) return p;
|
||||||
if(hitNone) return acc;
|
if(hitNone) return acc;
|
||||||
if(p.all) acc.all = true;
|
|
||||||
if(p.all || p.create) acc.create = true;
|
|
||||||
if(p.all || p.read) acc.read = true;
|
|
||||||
if(p.all || p.update) acc.update = true;
|
|
||||||
if(p.all || p.delete) acc.delete = true;
|
|
||||||
acc.methods = [...acc.methods, ...p.methods];
|
acc.methods = [...acc.methods, ...p.methods];
|
||||||
return acc;
|
return acc;
|
||||||
}, <any>null);
|
}, <any>null);
|
||||||
if(combined.all) combined.methods = ['*'];
|
combined.methods = new ASet<Method>(combined.methods);
|
||||||
if(combined.none) combined.methods = ['n'];
|
|
||||||
combined.methods = new ASet(combined.methods); // Make unique
|
|
||||||
combined.raw = PES`${combined.fullPath}:${combined.methods}`;
|
|
||||||
return combined;
|
return combined;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filter a set of paths based on the target
|
||||||
|
*
|
||||||
|
* @param {string | PathEvent | (string | PathEvent)[]} target Array of events that will filtered
|
||||||
|
* @param filter {...PathEvent} Must container one of
|
||||||
|
* @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 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.all || t.all || t.methods.intersection(f.methods).length));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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
|
||||||
*/
|
*/
|
||||||
@ -149,15 +161,15 @@ export class PathEvent {
|
|||||||
if(!r.fullPath && r.all) return true;
|
if(!r.fullPath && r.all) return true;
|
||||||
const filtered = parsedTarget.filter(p => r.fullPath.startsWith(p.fullPath));
|
const filtered = parsedTarget.filter(p => r.fullPath.startsWith(p.fullPath));
|
||||||
if(!filtered.length) return false;
|
if(!filtered.length) return false;
|
||||||
const combined = PathEvent.combine(filtered);
|
const combined = PathEvent.combine(...filtered);
|
||||||
return !combined.none && (combined.all || new ASet(combined.methods).intersection(new ASet(r.methods)).length);
|
return (!combined.none && (combined.all || r.all)) || combined.methods.intersection(r.methods).length;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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,40 +180,51 @@ 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 {
|
||||||
if(!PathEvent.has(target, ...has)) throw new Error(`Requires one of: ${makeArray(has).join(', ')}`);
|
if(!PathEvent.has(target, ...has)) throw new PathError(`Requires one of: ${makeArray(has).join(', ')}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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 {
|
||||||
if(!PathEvent.hasAll(target, ...has)) throw new Error(`Requires all: ${makeArray(has).join(', ')}`);
|
if(!PathEvent.hasAll(target, ...has)) throw new PathError(`Requires all: ${makeArray(has).join(', ')}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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('/');
|
||||||
|
p = p?.trim().replaceAll(/\/{2,}/g, '/').replaceAll(/(^\/|\/$)/g, '');
|
||||||
if(methods?.length) p += `:${makeArray(methods).map(m => m.toLowerCase()).join('')}`;
|
if(methods?.length) p += `:${makeArray(methods).map(m => m.toLowerCase()).join('')}`;
|
||||||
return p?.trim().replaceAll(/\/{2,}/g, '/').replaceAll(/(^\/|\/$)/g, '');
|
return p;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create pathed event string from its components
|
* Filter a set of paths based on this event
|
||||||
*
|
*
|
||||||
* @return {string} String representation of PathedEvent
|
* @param {string | PathEvent | (string | PathEvent)[]} target Array of events that will filtered
|
||||||
|
* @return {boolean} Whether there is any overlap
|
||||||
|
*/
|
||||||
|
filter(target: string | PathEvent | (string | PathEvent)[]): PathEvent[] {
|
||||||
|
return PathEvent.filter(target, this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create event string from its components
|
||||||
|
*
|
||||||
|
* @return {string} String representation of Event
|
||||||
*/
|
*/
|
||||||
toString() {
|
toString() {
|
||||||
return PathEvent.toString(this.fullPath, this.methods);
|
return PathEvent.toString(this.fullPath, this.methods);
|
||||||
@ -211,18 +234,18 @@ 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;
|
||||||
once(event: string, listener?: PathListener): Promise<any>;
|
once(event: string, listener?: PathListener): Promise<any>;
|
||||||
relayEvents(emitter: PathedEventEmitter): void;
|
relayEvents(emitter: PathEventEmitter): void;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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 PathedEventEmitter 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 +273,7 @@ export class PathedEventEmitter implements IPathedEventEmitter{
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
relayEvents(emitter: IPathedEventEmitter) {
|
relayEvents(emitter: IPathEventEmitter) {
|
||||||
emitter.on('*', (event, ...args) => this.emit(event, ...args));
|
emitter.on('*', (event, ...args) => this.emit(event, ...args));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -13,7 +13,7 @@ export default defineConfig({
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
emptyOutDir: true,
|
emptyOutDir: true,
|
||||||
minify: true,
|
minify: false,
|
||||||
sourcemap: true
|
sourcemap: true
|
||||||
},
|
},
|
||||||
plugins: [dts()],
|
plugins: [dts()],
|
||||||
|
|||||||
Reference in New Issue
Block a user