Compare commits

...

17 Commits

Author SHA1 Message Date
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
2fda11f3b7 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 26s
2024-10-14 14:06:06 -04:00
379de273c4 Added path-events
All checks were successful
Build / Build NPM Project (push) Successful in 31s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 28s
2024-10-14 13:52:03 -04:00
c51239d12b Bump 0.18.2
All checks were successful
Build / Build NPM Project (push) Successful in 25s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 26s
2024-10-12 12:30:23 -04:00
e4229296c1 Added escapeRegex
All checks were successful
Build / Build NPM Project (push) Successful in 59s
Build / Tag Version (push) Successful in 14s
Build / Publish Documentation (push) Successful in 42s
2024-10-12 12:27:45 -04:00
b93ed45521 Renamed sleepUntil to sleepWhile, it was misleading
All checks were successful
Build / Build NPM Project (push) Successful in 1m5s
Build / Tag Version (push) Successful in 14s
Build / Publish Documentation (push) Successful in 39s
2024-10-07 15:40:14 -04:00
3e8f5cc00b Add or remove multiple elements from ASet at once
All checks were successful
Build / Build NPM Project (push) Successful in 30s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 27s
2024-10-06 19:14:36 -04:00
54a2880391 Updated docs
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 25s
2024-10-01 15:44:49 -04:00
b7aeee4706 Fixing docker container
All checks were successful
Build / Build NPM Project (push) Successful in 25s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 25s
2024-10-01 15:39:24 -04:00
b3eab0d6c9 Created docs docker container
All checks were successful
Build / Build NPM Project (push) Successful in 26s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 19s
2024-10-01 15:22:48 -04:00
ad4194a981 Fixed extracting version number during build
Some checks failed
Build / Build NPM Project (push) Successful in 27s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Failing after 8s
2024-10-01 15:13:47 -04:00
e1f22a01a6 Added docs container
Some checks failed
Build / Build NPM Project (push) Successful in 31s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Failing after 5s
2024-10-01 15:08:52 -04:00
91c0858d9f Added var-persist
All checks were successful
Build / Build NPM Project (push) Successful in 28s
Build / Tag Version (push) Successful in 6s
2024-09-30 21:43:13 -04:00
8094b6507f Updated cache indexing signature
All checks were successful
Build / Build NPM Project (push) Successful in 26s
Build / Tag Version (push) Successful in 7s
2024-09-30 19:39:06 -04:00
e40f410830 Removed window reference from jwtDecode
All checks were successful
Build / Build NPM Project (push) Successful in 27s
Build / Tag Version (push) Successful in 7s
2024-09-30 16:18:07 -04:00
13 changed files with 371 additions and 5631 deletions

View File

@ -48,3 +48,13 @@ jobs:
uses: ztimson/actions/tag@develop
with:
tag: ${{env.VERSION}}
docs:
name: Publish Documentation
needs: build
uses: ztimson/actions/.github/workflows/docker.yaml@develop
with:
name: ztimson/utils
repository: ${{github.server_url}}/${{github.repository}}.git
pass: ${{secrets.DEPLOY_TOKEN}}

13
Dockerfile Normal file
View File

@ -0,0 +1,13 @@
# Build application
FROM node:alpine as build
RUN mkdir /app
WORKDIR /app
COPY . .
RUN if [ ! -d "node_modules" ]; then npm i; fi && \
if [ ! -d "dist" ]; then npm run docs; fi
# Use Nginx to serve
FROM nginx:1.23-alpine
COPY --from=build /app/docs /usr/share/nginx/html

View File

@ -20,7 +20,7 @@ Javascript/Typescript Utilities
---
<div>
<a href="https://git.zakscode.com/ztimson/utils/wiki" target="_blank">Documentation</a>
<a href="https://utils.docs.zakscode.com" target="_blank">Documentation</a>
<a href="https://git.zakscode.com/ztimson/utils/releases" target="_blank">Release Notes</a>
<a href="https://git.zakscode.com/ztimson/utils/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
<a href="https://git.zakscode.com/ztimson/utils/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
@ -36,7 +36,7 @@ Javascript/Typescript Utilities
- [Setup](#setup)
- [Production](#production)
- [Development](#development)
- [Documentation](https://git.zakscode.com/ztimson/utils/wiki)
- [Documentation](https://utils.docs.zakscode.com/)
- [License](#license)
## About
@ -82,7 +82,7 @@ A collection of utilities to make life a little easier
## Documentation
[Available Here](https://git.zakscode.com/ztimson/utils/wiki)
[Available Here](https://utils.docs.zakscode.com/)
## License

5593
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,6 +1,6 @@
{
"name": "@ztimson/utils",
"version": "0.16.8",
"version": "0.20.1",
"description": "Utility library",
"author": "Zak Timson",
"license": "MIT",
@ -21,7 +21,7 @@
},
"scripts": {
"build": "npx tsc && npx vite build",
"docs": "typedoc --plugin typedoc-plugin-markdown --cleanOutputDir false --outputFileStrategy modules --hidePageHeader --out ./docs --entryPoints src/**/*.ts --readme none --entryFileName Home",
"docs": "typedoc --cleanOutputDir false --out ./docs --entryPoints src/**/*.ts --readme none",
"test": "npx jest",
"test:coverage": "npx jest --coverage",
"watch": "npx vite build --watch"
@ -32,7 +32,6 @@
"jest-junit": "^16.0.0",
"ts-jest": "^29.1.2",
"typedoc": "^0.26.7",
"typedoc-plugin-markdown": "^4.2.7",
"typescript": "^5.3.3",
"vite": "^5.0.12",
"vite-plugin-dts": "^3.7.2"

View File

@ -19,20 +19,22 @@ export class ASet<T> extends Array {
}
/**
* Add single element to set if unique
* @param {T} el Element to add
* Add elements to set if unique
* @param items
*/
add(el: T) {
if(!this.has(el)) this.push(el);
add(...items: T[]) {
items.filter(el => !this.has(el)).forEach(el => this.push(el));
}
/**
* Delete element from set
* @param {T} el Element that will be deleted
* Delete elements from set
* @param items Elements that will be deleted
*/
delete(el: T) {
delete(...items: T[]) {
items.forEach(el => {
const index = this.indexOf(el);
if(index != -1) this.slice(index, 1);
})
}
/**

View File

@ -1,9 +1,20 @@
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
*/
export class Cache<K, T> {
private store: any = {};
export class Cache<K extends string | number | symbol, T> {
private store = <Record<K, T>>{};
/** Support index lookups */
[key: string | number | symbol]: T | any;
/** Whether cache is complete */
complete = false;
@ -11,23 +22,33 @@ export class Cache<K, T> {
* Create new cache
*
* @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, {
get: (target: this, prop: string | symbol) => {
if(prop in target) return (<any>target)[prop];
return target.store[prop];
if (prop in target) return (target as any)[prop];
return target.store[prop as K];
},
set: (target: any, prop: string | symbol, value: T) => {
if(prop in target) target[prop] = value;
else target.store[prop] = value;
set: (target: this, prop: string | symbol, value: any) => {
if (prop in target) (target as any)[prop] = value;
else target.store[prop as K] = value;
return true;
}
});
}
private getKey(value: T): K {
if(!this.key) throw new Error('No key defined');
return <K>value[this.key];
}
@ -73,6 +94,8 @@ export class Cache<K, T> {
*/
delete(key: K) {
delete this.store[key];
if(this.options.storageKey && this.options.storage)
this.options.storage.setItem(this.options.storageKey, JSON.stringify(this.store));
}
/**
@ -101,20 +124,31 @@ export class Cache<K, T> {
return <K[]>Object.keys(this.store);
}
/**
* Get map of cached items
*
* @return {Record<K, T>}
*/
map(): Record<K, T> {
return structuredClone(this.store);
}
/**
* Add an item to the cache manually specifying the key
*
* @param {K} key Key item will be cached under
* @param {T} value Item to cache
* @param {number | undefined} ttl Override default expiry
* @param {number | undefined} ttl Override default expiry in seconds
* @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;
if(this.options.storageKey && this.options.storage)
this.options.storage.setItem(this.options.storageKey, JSON.stringify(this.store));
if(ttl) setTimeout(() => {
this.complete = false;
this.delete(key);
}, ttl);
}, ttl * 1000);
return this;
}

View File

@ -1,29 +1,33 @@
export type Listener = (...args: any[]) => any;
export type TypedEvents = {[k in string | symbol]: Listener} & {'*': (event: string, ...args: any[]) => any};
export type TypedListener = (...args: any[]) => any;
export type TypedEvents = {[k in string | symbol]: TypedListener} & {'*': (event: string, ...args: any[]) => any};
export type NamespaceEvents<Namespace extends string, Events extends TypedEvents> = {
[K in keyof Events as `${Namespace}:${Extract<K, string>}`]: Events[K];
};
export class TypedEmitter<T extends TypedEvents = TypedEvents> {
private static listeners: {[key: string]: Listener[]} = {};
private static listeners: {[key: string]: TypedListener[]} = {};
private listeners: { [key in keyof T]?: Listener[] } = {};
private listeners: { [key in keyof T]?: TypedListener[] } = {};
static emit(event: any, ...args: any[]) {
(this.listeners['*'] || []).forEach(l => l(event, ...args));
(this.listeners[event.toString()] || []).forEach(l => l(...args));
};
static off(event: any, listener: Listener) {
static off(event: any, listener: TypedListener) {
const e = event.toString();
this.listeners[e] = (this.listeners[e] || []).filter(l => l === listener);
}
static on(event: any, listener: Listener) {
static on(event: any, listener: TypedListener) {
const e = event.toString();
if(!this.listeners[e]) this.listeners[e] = [];
this.listeners[e]?.push(listener);
return () => this.off(event, listener);
}
static once(event: any, listener?: Listener): Promise<any> {
static once(event: any, listener?: TypedListener): Promise<any> {
return new Promise(res => {
const unsubscribe = this.on(event, <any>((...args: any) => {
res(args.length == 1 ? args[0] : args);

View File

@ -11,6 +11,7 @@ export * from './logger';
export * from './math';
export * from './misc';
export * from './objects';
export * from './path-events';
export * from './promise-progress';
export * from './string';
export * from './time';

View File

@ -6,10 +6,10 @@ import {JSONAttemptParse} from './objects.ts';
* @param {string} token JWT to decode
* @return {unknown} JWT payload
*/
export function decodeJwt<T>(token: string): T {
export function jwtDecode<T>(token: string): T {
const base64 = token.split('.')[1]
.replace(/-/g, '+').replace(/_/g, '/');
return <T>JSONAttemptParse(decodeURIComponent(window.atob(base64).split('').map(function(c) {
return <T>JSONAttemptParse(decodeURIComponent(atob(base64).split('').map(function(c) {
return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2);
}).join('')));
}

View File

@ -1,3 +1,4 @@
import {PathEvent} from './path-events.ts';
import {md5} from './string';
/**
@ -11,3 +12,16 @@ export function gravatar(email: string, def='mp') {
if(!email) return '';
return `https://www.gravatar.com/avatar/${md5(email)}?d=${def}`;
}
/**
* 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, '\\$&');
}
export type Listener = (event: PathEvent, ...args: any[]) => any;
export type Unsubscribe = () => void;

256
src/path-events.ts Normal file
View File

@ -0,0 +1,256 @@
import {makeArray} from './array.ts';
import {ASet} from './aset.ts';
/**
* Available methods:
* * - All/Wildcard
* n - None
* c - Create
* r - Read
* u - Update
* d - Delete
* x - Execute
*/
export type Method = '*' | 'n' | 'c' | 'r' | 'u' | 'd' | 'x';
/**
* Shorthand for creating Event from a string
*
* @example
* ```ts
* const event: Event = PE`users/system:*`;
* ```
*
* @param {TemplateStringsArray} str String that will be parsed into Event
* @param {string} args
* @return {PathEvent} Event object
*/
export function PE(str: TemplateStringsArray, ...args: string[]) {
const combined = [];
for(let i = 0; i < str.length || i < args.length; i++) {
if(str[i]) combined.push(str[i]);
if(args[i]) combined.push(args[i]);
}
return new PathEvent(combined.join(''));
}
/**
* Shorthand for creating Event strings, ensures paths are correct
*
* @param {TemplateStringsArray} str
* @param {string} args
* @return {string}
* @constructor
*/
export function PES(str: TemplateStringsArray, ...args: any[]) {
let combined = [];
for(let i = 0; i < str.length || i < args.length; i++) {
if(str[i]) combined.push(str[i]);
if(args[i]) combined.push(args[i]);
}
const [paths, methods] = combined.join('').split(':');
return PathEvent.toString(paths, <any>methods?.split(''));
}
/**
* A event broken down into its core components for easy processing
* Event Structure: `module/path/name:property:method`
* Example: `users/system:crud` or `storage/some/path/file.txt:r`
*/
export class PathEvent {
/** First directory in path */
module!: string;
/** Entire path, including the module & name */
fullPath!: string;
/** Path including the name, excluding the module */
path!: string;
/** Last sagment of path */
name!: string;
/** List of methods */
methods!: 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(Event: string | PathEvent) {
if(typeof Event == 'object') return Object.assign(this, Event);
let [p, scope, method] = Event.split(':');
if(!method) method = scope || '*';
if(p == '*' || !p && method == '*') {
p = '';
method = '*';
}
let temp = p.split('/').filter(p => !!p);
this.module = temp.splice(0, 1)[0]?.toLowerCase() || '';
this.fullPath = p;
this.path = temp.join('/');
this.name = temp.pop() || '';
this.methods = <Method[]>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 events into one parsed object. Longest path takes precedent, but all subsequent methods are
* combined until a "none" is reached
*
* @param {string | PathEvent} paths Events as strings or pre-parsed
* @return {PathEvent} Final combined permission
*/
static combine(paths: (string | PathEvent)[]): PathEvent {
let hitNone = false;
const combined = paths.map(p => new PathEvent(p))
.toSorted((p1, p2) => {
const l1 = p1.fullPath.length, l2 = p2.fullPath.length;
return l1 < l2 ? 1 : (l1 > l2 ? -1 : 0);
}).reduce((acc, p) => {
if(p.none) hitNone = true;
if(!acc) return p;
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];
return acc;
}, <any>null);
if(combined.all) 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;
}
/**
* Squash 2 sets of paths & return true if any overlap is found
*
* @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
* @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 || new ASet(combined.methods).intersection(new ASet(r.methods)).length);
});
}
/**
* Squash 2 sets of paths & return true if the target has all paths
*
* @param {string | PathEvent | (string | PathEvent)[]} target Array of Events as strings or pre-parsed
* @param has Target must have all these paths
* @return {boolean} Whether there is any overlap
*/
static hasAll(target: string | PathEvent | (string | PathEvent)[], ...has: (string | PathEvent)[]): boolean {
return has.filter(h => PathEvent.has(target, h)).length == has.length;
}
/**
* Same as `has` but raises an error if there is no overlap
*
* @param {string | string[]} target Array of Events as strings or pre-parsed
* @param has Target must have at least one of these path
*/
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(', ')}`);
}
/**
* Same as `hasAll` but raises an error if the target is missing any paths
*
* @param {string | string[]} target Array of Events as strings or pre-parsed
* @param has Target must have all these paths
*/
static hasAllFatal(target: string | PathEvent | (string | PathEvent)[], ...has: (string | PathEvent)[]): void {
if(!PathEvent.hasAll(target, ...has)) throw new Error(`Requires all: ${makeArray(has).join(', ')}`);
}
/**
* Create event string from its components
*
* @param {string | string[]} path Event path
* @param {Method} methods Event method
* @return {string} String representation of Event
*/
static toString(path: string | string[], methods: Method | Method[]): string {
let p = makeArray(path).filter(p => p != null).join('/');
if(methods?.length) p += `:${makeArray(methods).map(m => m.toLowerCase()).join('')}`;
return p?.trim().replaceAll(/\/{2,}/g, '/').replaceAll(/(^\/|\/$)/g, '');
}
/**
* Create event string from its components
*
* @return {string} String representation of Event
*/
toString() {
return PathEvent.toString(this.fullPath, this.methods);
}
}
export type PathListener = (event: PathEvent, ...args: any[]) => any;
export type PathUnsubscribe = () => void;
export interface IPathEventEmitter {
emit(event: string, ...args: any[]): void;
off(listener: PathListener): void;
on(event: string, listener: PathListener): PathUnsubscribe;
once(event: string, listener?: PathListener): Promise<any>;
relayEvents(emitter: PathEventEmitter): void;
}
/**
* Event emitter that uses paths allowing listeners to listen to different combinations of modules, paths & methods
*/
export class PathEventEmitter implements IPathEventEmitter{
private listeners: [PathEvent, PathListener][] = [];
emit(event: string | PathEvent, ...args: any[]) {
const parsed = new PathEvent(event);
this.listeners.filter(l => PathEvent.has(l[0], event))
.forEach(async l => l[1](parsed, ...args));
};
off(listener: PathListener) {
this.listeners = this.listeners.filter(l => l[1] != listener);
}
on(event: string | string[], listener: PathListener): PathUnsubscribe {
makeArray(event).forEach(e => this.listeners.push([new PathEvent(e), listener]));
return () => this.off(listener);
}
once(event: string | string[], listener?: PathListener): Promise<any> {
return new Promise(res => {
const unsubscribe = this.on(event, (event: PathEvent, ...args: any[]) => {
res(args.length < 2 ? args[0] : args);
if(listener) listener(event, ...args);
unsubscribe();
});
});
}
relayEvents(emitter: IPathEventEmitter) {
emitter.on('*', (event, ...args) => this.emit(event, ...args));
}
}

View File

@ -36,14 +36,14 @@ export function sleep(ms: number): Promise<void> {
* ```js
* let loading = true;
* setTimeout(() => wait = false, 1000);
* await sleepUntil(() => loading); // Won't continue until loading flag is false
* await sleepWhile(() => loading); // Won't continue until loading flag is false
* ```
*
* @param {() => boolean | Promise<boolean>} fn Return true to continue
* @param {number} checkInterval Run function ever x milliseconds
* @return {Promise<void>} Callback when sleep is over
*/
export async function sleepUntil(fn : () => boolean | Promise<boolean>, checkInterval = 100): Promise<void> {
export async function sleepWhile(fn : () => boolean | Promise<boolean>, checkInterval = 100): Promise<void> {
while(await fn()) await sleep(checkInterval);
}