Compare commits
43 Commits
Author | SHA1 | Date | |
---|---|---|---|
ce40b5b1e7 | |||
2500bcdcf1 | |||
db18c010aa | |||
b292d5ed17 | |||
a1ea8cdf67 | |||
fbbe3c99ef | |||
1c1a3f6a6e | |||
2dce1ad9ac | |||
cebfd2c508 | |||
7c5cf3535d | |||
847b493772 | |||
b1005227ab | |||
3a389de72e | |||
151465aa65 | |||
b103b6f786 | |||
3b486310de | |||
8699fb49ff | |||
fdb29e7984 | |||
274c22bb83 | |||
b21f462d35 | |||
0f10aebfd2 | |||
1af23ac544 | |||
494cfaaccd | |||
23df6ad265 | |||
2fda11f3b7 | |||
379de273c4 | |||
c51239d12b | |||
e4229296c1 | |||
b93ed45521 | |||
3e8f5cc00b | |||
54a2880391 | |||
b7aeee4706 | |||
b3eab0d6c9 | |||
ad4194a981 | |||
e1f22a01a6 | |||
91c0858d9f | |||
8094b6507f | |||
e40f410830 | |||
c1043e65e2 | |||
67d9928a61 | |||
e6636d373b | |||
811d797e1b | |||
0909c4f648 |
10
.github/workflows/build.yaml
vendored
10
.github/workflows/build.yaml
vendored
@ -48,3 +48,13 @@ jobs:
|
|||||||
uses: ztimson/actions/tag@develop
|
uses: ztimson/actions/tag@develop
|
||||||
with:
|
with:
|
||||||
tag: ${{env.VERSION}}
|
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}}
|
||||||
|
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
|
13
Dockerfile
Normal file
13
Dockerfile
Normal 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
|
@ -20,7 +20,7 @@ Javascript/Typescript Utilities
|
|||||||
|
|
||||||
---
|
---
|
||||||
<div>
|
<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/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%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>
|
• <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)
|
- [Setup](#setup)
|
||||||
- [Production](#production)
|
- [Production](#production)
|
||||||
- [Development](#development)
|
- [Development](#development)
|
||||||
- [Documentation](https://git.zakscode.com/ztimson/utils/wiki)
|
- [Documentation](https://utils.docs.zakscode.com/)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
|
|
||||||
## About
|
## About
|
||||||
@ -82,7 +82,7 @@ A collection of utilities to make life a little easier
|
|||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
[Available Here](https://git.zakscode.com/ztimson/utils/wiki)
|
[Available Here](https://utils.docs.zakscode.com/)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
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>
|
5593
package-lock.json
generated
5593
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.16.3",
|
"version": "0.22.1",
|
||||||
"description": "Utility library",
|
"description": "Utility library",
|
||||||
"author": "Zak Timson",
|
"author": "Zak Timson",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
@ -21,7 +21,7 @@
|
|||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "npx tsc && npx vite build",
|
"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": "npx jest",
|
||||||
"test:coverage": "npx jest --coverage",
|
"test:coverage": "npx jest --coverage",
|
||||||
"watch": "npx vite build --watch"
|
"watch": "npx vite build --watch"
|
||||||
@ -32,7 +32,6 @@
|
|||||||
"jest-junit": "^16.0.0",
|
"jest-junit": "^16.0.0",
|
||||||
"ts-jest": "^29.1.2",
|
"ts-jest": "^29.1.2",
|
||||||
"typedoc": "^0.26.7",
|
"typedoc": "^0.26.7",
|
||||||
"typedoc-plugin-markdown": "^4.2.7",
|
|
||||||
"typescript": "^5.3.3",
|
"typescript": "^5.3.3",
|
||||||
"vite": "^5.0.12",
|
"vite": "^5.0.12",
|
||||||
"vite-plugin-dts": "^3.7.2"
|
"vite-plugin-dts": "^3.7.2"
|
||||||
|
35
src/aset.ts
35
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
|
||||||
@ -19,20 +21,24 @@ export class ASet<T> extends Array {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Add single element to set if unique
|
* Add elements to set if unique
|
||||||
* @param {T} el Element to add
|
* @param items
|
||||||
*/
|
*/
|
||||||
add(el: T) {
|
add(...items: T[]) {
|
||||||
if(!this.has(el)) this.push(el);
|
items.filter(el => !this.has(el)).forEach(el => this.push(el));
|
||||||
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete element from set
|
* Delete elements from set
|
||||||
* @param {T} el Element that will be deleted
|
* @param items Elements that will be deleted
|
||||||
*/
|
*/
|
||||||
delete(el: T) {
|
delete(...items: T[]) {
|
||||||
const index = this.indexOf(el);
|
items.forEach(el => {
|
||||||
if(index != -1) this.slice(index, 1);
|
const index = this.indexOf(el);
|
||||||
|
if(index != -1) this.splice(index, 1);
|
||||||
|
})
|
||||||
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -53,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
|
||||||
|
117
src/cache.ts
117
src/cache.ts
@ -1,8 +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
|
* Map of data which tracks whether it is a complete collection & offers optional expiry of cached values
|
||||||
*/
|
*/
|
||||||
export class Cache<K, T> extends Map<K, T> {
|
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 */
|
/** Whether cache is complete */
|
||||||
complete = false;
|
complete = false;
|
||||||
|
|
||||||
@ -10,13 +22,33 @@ export class Cache<K, T> extends Map<K, 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 = {}) {
|
||||||
super();
|
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, {
|
||||||
|
get: (target: this, prop: string | symbol) => {
|
||||||
|
if (prop in target) return (target as any)[prop];
|
||||||
|
return target.store[prop as K];
|
||||||
|
},
|
||||||
|
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 {
|
private getKey(value: T): K {
|
||||||
|
if(!this.key) throw new Error('No key defined');
|
||||||
return <K>value[this.key];
|
return <K>value[this.key];
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -25,8 +57,8 @@ export class Cache<K, T> extends Map<K, T> {
|
|||||||
*
|
*
|
||||||
* @return {T[]} Array of items
|
* @return {T[]} Array of items
|
||||||
*/
|
*/
|
||||||
all() {
|
all(): T[] {
|
||||||
return Array.from(this.values());
|
return Object.values(this.store);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -55,19 +87,82 @@ export class Cache<K, T> extends Map<K, T> {
|
|||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove all keys from cache
|
||||||
|
*/
|
||||||
|
clear() {
|
||||||
|
this.store = <Record<K, T>>{};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Delete an item from the cache
|
||||||
|
*
|
||||||
|
* @param {K} key Item's primary key
|
||||||
|
*/
|
||||||
|
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));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return cache as an array of key-value pairs
|
||||||
|
* @return {[K, T][]} Key-value pairs array
|
||||||
|
*/
|
||||||
|
entries(): [K, T][] {
|
||||||
|
return <[K, T][]>Object.entries(this.store);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get item from the cache
|
||||||
|
* @param {K} key Key to lookup
|
||||||
|
* @return {T} Cached item
|
||||||
|
*/
|
||||||
|
get(key: K): T {
|
||||||
|
return this.store[key];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a list of cached keys
|
||||||
|
*
|
||||||
|
* @return {K[]} Array of keys
|
||||||
|
*/
|
||||||
|
keys(): K[] {
|
||||||
|
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
|
* Add an item to the cache manually specifying the key
|
||||||
|
*
|
||||||
* @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 {
|
||||||
super.set(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;
|
||||||
super.delete(key)
|
this.delete(key);
|
||||||
}, ttl);
|
}, ttl * 1000);
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all cached items
|
||||||
|
*
|
||||||
|
* @return {T[]} Array of items
|
||||||
|
*/
|
||||||
|
values = this.all();
|
||||||
}
|
}
|
||||||
|
@ -1,29 +1,33 @@
|
|||||||
export type Listener = (...args: any[]) => any;
|
export type TypedListener = (...args: any[]) => any;
|
||||||
export type TypedEvents = {[k in string | symbol]: Listener} & {'*': (event: string, ...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> {
|
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[]) {
|
static emit(event: any, ...args: any[]) {
|
||||||
(this.listeners['*'] || []).forEach(l => l(event, ...args));
|
(this.listeners['*'] || []).forEach(l => l(event, ...args));
|
||||||
(this.listeners[event.toString()] || []).forEach(l => l(...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();
|
const e = event.toString();
|
||||||
this.listeners[e] = (this.listeners[e] || []).filter(l => l === listener);
|
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();
|
const e = event.toString();
|
||||||
if(!this.listeners[e]) this.listeners[e] = [];
|
if(!this.listeners[e]) this.listeners[e] = [];
|
||||||
this.listeners[e]?.push(listener);
|
this.listeners[e]?.push(listener);
|
||||||
return () => this.off(event, 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 => {
|
return new Promise(res => {
|
||||||
const unsubscribe = this.on(event, <any>((...args: any) => {
|
const unsubscribe = this.on(event, <any>((...args: any) => {
|
||||||
res(args.length == 1 ? args[0] : args);
|
res(args.length == 1 ? args[0] : args);
|
||||||
|
@ -180,7 +180,6 @@ export class GatewayTimeoutError extends CustomError {
|
|||||||
* @return {CustomError} The proper error type
|
* @return {CustomError} The proper error type
|
||||||
*/
|
*/
|
||||||
export function errorFromCode(code: number, message?: string) {
|
export function errorFromCode(code: number, message?: string) {
|
||||||
if(code >= 200 && code < 300) return null;
|
|
||||||
switch(code) {
|
switch(code) {
|
||||||
case 400:
|
case 400:
|
||||||
return new BadRequestError(message);
|
return new BadRequestError(message);
|
||||||
|
81
src/http.ts
81
src/http.ts
@ -75,47 +75,52 @@ export class Http {
|
|||||||
|
|
||||||
// Send request
|
// Send request
|
||||||
return new PromiseProgress((res, rej, prog) => {
|
return new PromiseProgress((res, rej, prog) => {
|
||||||
fetch(url, {
|
try {
|
||||||
headers,
|
fetch(url, {
|
||||||
method: opts.method || (opts.body ? 'POST' : 'GET'),
|
headers,
|
||||||
body: opts.body
|
method: opts.method || (opts.body ? 'POST' : 'GET'),
|
||||||
}).then(async (resp: any) => {
|
body: opts.body
|
||||||
for(let fn of [...Object.values(Http.interceptors), ...Object.values(this.interceptors)]) {
|
}).then(async (resp: any) => {
|
||||||
await new Promise<void>(res => fn(resp, () => res()));
|
for(let fn of [...Object.values(Http.interceptors), ...Object.values(this.interceptors)]) {
|
||||||
}
|
await new Promise<void>(res => fn(resp, () => res()));
|
||||||
|
|
||||||
const contentLength = resp.headers.get('Content-Length');
|
|
||||||
const total = contentLength ? parseInt(contentLength, 10) : 0;
|
|
||||||
let loaded = 0;
|
|
||||||
|
|
||||||
const reader = resp.body?.getReader();
|
|
||||||
const stream = new ReadableStream({
|
|
||||||
start(controller) {
|
|
||||||
function push() {
|
|
||||||
reader?.read().then((event: any) => {
|
|
||||||
if(event.done) return controller.close();
|
|
||||||
loaded += event.value.byteLength;
|
|
||||||
prog(loaded / total);
|
|
||||||
controller.enqueue(event.value);
|
|
||||||
push();
|
|
||||||
}).catch((error: any) => controller.error(error));
|
|
||||||
}
|
|
||||||
push();
|
|
||||||
}
|
}
|
||||||
});
|
|
||||||
|
|
||||||
resp.data = new Response(stream);
|
const contentLength = resp.headers.get('Content-Length');
|
||||||
if(opts.decode == null || opts.decode) {
|
const total = contentLength ? parseInt(contentLength, 10) : 0;
|
||||||
const content = resp.headers.get('Content-Type')?.toLowerCase();
|
let loaded = 0;
|
||||||
if(content?.includes('form')) resp.data = <T>await resp.data.formData();
|
|
||||||
else if(content?.includes('json')) resp.data = <T>await resp.data.json();
|
|
||||||
else if(content?.includes('text')) resp.data = <T>await resp.data.text();
|
|
||||||
else if(content?.includes('application')) resp.data = <T>await resp.data.blob();
|
|
||||||
}
|
|
||||||
|
|
||||||
if(resp.ok) res(resp);
|
const reader = resp.body?.getReader();
|
||||||
else rej(resp);
|
const stream = new ReadableStream({
|
||||||
})
|
start(controller) {
|
||||||
|
function push() {
|
||||||
|
reader?.read().then((event: any) => {
|
||||||
|
if(event.done) return controller.close();
|
||||||
|
loaded += event.value.byteLength;
|
||||||
|
prog(loaded / total);
|
||||||
|
controller.enqueue(event.value);
|
||||||
|
push();
|
||||||
|
}).catch((error: any) => controller.error(error));
|
||||||
|
}
|
||||||
|
|
||||||
|
push();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
resp.data = new Response(stream);
|
||||||
|
if(opts.decode == null || opts.decode) {
|
||||||
|
const content = resp.headers.get('Content-Type')?.toLowerCase();
|
||||||
|
if(content?.includes('form')) resp.data = <T>await resp.data.formData();
|
||||||
|
else if(content?.includes('json')) resp.data = <T>await resp.data.json();
|
||||||
|
else if(content?.includes('text')) resp.data = <T>await resp.data.text();
|
||||||
|
else if(content?.includes('application')) resp.data = <T>await resp.data.blob();
|
||||||
|
}
|
||||||
|
|
||||||
|
if(resp.ok) res(resp);
|
||||||
|
else rej(resp);
|
||||||
|
}).catch(err => rej(err));
|
||||||
|
} catch(err) {
|
||||||
|
rej(err);
|
||||||
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -6,10 +6,12 @@ export * from './files';
|
|||||||
export * from './emitter';
|
export * from './emitter';
|
||||||
export * from './errors';
|
export * from './errors';
|
||||||
export * from './http';
|
export * from './http';
|
||||||
|
export * from './jwt';
|
||||||
export * from './logger';
|
export * from './logger';
|
||||||
export * from './math';
|
export * from './math';
|
||||||
export * from './misc';
|
export * from './misc';
|
||||||
export * from './objects';
|
export * from './objects';
|
||||||
|
export * from './path-events';
|
||||||
export * from './promise-progress';
|
export * from './promise-progress';
|
||||||
export * from './string';
|
export * from './string';
|
||||||
export * from './time';
|
export * from './time';
|
||||||
|
15
src/jwt.ts
Normal file
15
src/jwt.ts
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
import {JSONAttemptParse} from './objects.ts';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Decode a JWT payload, this will not check for tampering so be careful
|
||||||
|
*
|
||||||
|
* @param {string} token JWT to decode
|
||||||
|
* @return {unknown} JWT payload
|
||||||
|
*/
|
||||||
|
export function jwtDecode<T>(token: string): T {
|
||||||
|
const base64 = token.split('.')[1]
|
||||||
|
.replace(/-/g, '+').replace(/_/g, '/');
|
||||||
|
return <T>JSONAttemptParse(decodeURIComponent(atob(base64).split('').map(function(c) {
|
||||||
|
return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2);
|
||||||
|
}).join('')));
|
||||||
|
}
|
@ -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
src/misc.ts
14
src/misc.ts
@ -1,3 +1,4 @@
|
|||||||
|
import {PathEvent} from './path-events.ts';
|
||||||
import {md5} from './string';
|
import {md5} from './string';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -11,3 +12,16 @@ export function gravatar(email: string, def='mp') {
|
|||||||
if(!email) return '';
|
if(!email) return '';
|
||||||
return `https://www.gravatar.com/avatar/${md5(email)}?d=${def}`;
|
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;
|
||||||
|
@ -29,10 +29,10 @@ export function clean<T>(obj: T, undefinedOnly = false): Partial<T> {
|
|||||||
* Should be replaced by `structuredClone` once released.
|
* Should be replaced by `structuredClone` once released.
|
||||||
* @param {T} value Object to copy
|
* @param {T} value Object to copy
|
||||||
* @returns {T} Type
|
* @returns {T} Type
|
||||||
* @deprecated Please use `structuredClone`
|
|
||||||
*/
|
*/
|
||||||
export function deepCopy<T>(value: T): T {
|
export function deepCopy<T>(value: T): T {
|
||||||
return structuredClone(value);
|
try {return structuredClone(value); }
|
||||||
|
catch { return JSON.parse(JSONSanitize(value)); }
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -234,10 +234,8 @@ export function JSONAttemptParse<T>(json: string): T | string {
|
|||||||
export function JSONSanitize(obj: any, space?: number): string {
|
export function JSONSanitize(obj: any, space?: number): string {
|
||||||
let cache: any[] = [];
|
let cache: any[] = [];
|
||||||
return JSON.stringify(obj, (key, value) => {
|
return JSON.stringify(obj, (key, value) => {
|
||||||
if (typeof value === 'object' && value !== null) {
|
if(typeof value === 'object' && value !== null)
|
||||||
if (cache.includes(value)) return;
|
if(!cache.includes(value)) cache.push(value);
|
||||||
cache.push(value);
|
|
||||||
}
|
|
||||||
return value;
|
return value;
|
||||||
}, space);
|
}, space);
|
||||||
}
|
}
|
||||||
|
279
src/path-events.ts
Normal file
279
src/path-events.ts
Normal file
@ -0,0 +1,279 @@
|
|||||||
|
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(''));
|
||||||
|
}
|
||||||
|
|
||||||
|
export class PathError extends Error { }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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!: ASet<Method>;
|
||||||
|
|
||||||
|
/** All/Wildcard specified */
|
||||||
|
get all(): boolean { return this.methods.has('*') }
|
||||||
|
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(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 = new ASet(<any>method.split(''));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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;
|
||||||
|
acc.methods = [...acc.methods, ...p.methods];
|
||||||
|
return acc;
|
||||||
|
}, <any>null);
|
||||||
|
combined.methods = new ASet<Method>(combined.methods);
|
||||||
|
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
|
||||||
|
*
|
||||||
|
* @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 || r.all)) || combined.methods.intersection(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 PathError(`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 PathError(`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('/');
|
||||||
|
p = p?.trim().replaceAll(/\/{2,}/g, '/').replaceAll(/(^\/|\/$)/g, '');
|
||||||
|
if(methods?.length) p += `:${makeArray(methods).map(m => m.toLowerCase()).join('')}`;
|
||||||
|
return p;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filter a set of paths based on this event
|
||||||
|
*
|
||||||
|
* @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() {
|
||||||
|
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));
|
||||||
|
}
|
||||||
|
}
|
@ -1,5 +1,3 @@
|
|||||||
import {dotNotation, flattenObj} from './objects.ts';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* String of all letters
|
* String of all letters
|
||||||
*/
|
*/
|
||||||
@ -44,7 +42,7 @@ export function formatBytes(bytes: number, decimals = 2) {
|
|||||||
export function formatPhoneNumber(number: string) {
|
export function formatPhoneNumber(number: string) {
|
||||||
const parts = /(\+?1)?.*?(\d{3}).*?(\d{3}).*?(\d{4})/g.exec(number);
|
const parts = /(\+?1)?.*?(\d{3}).*?(\d{3}).*?(\d{4})/g.exec(number);
|
||||||
if(!parts) throw new Error(`Number cannot be parsed: ${number}`);
|
if(!parts) throw new Error(`Number cannot be parsed: ${number}`);
|
||||||
return `${parts[1] ?? ''} (${parts[2]}) ${parts[3]}-${parts[4]}`.trim();
|
return `${parts[1] ? '+1' : ''} (${parts[2]}) ${parts[3]}-${parts[4]}`.trim();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -60,6 +58,7 @@ export function formatPhoneNumber(number: string) {
|
|||||||
* @param {string} str - Value that will be injected to parent
|
* @param {string} str - Value that will be injected to parent
|
||||||
* @param {number} index - Position to inject string at
|
* @param {number} index - Position to inject string at
|
||||||
* @returns {string} - New string
|
* @returns {string} - New string
|
||||||
|
* @deprecated use `strSplice()`
|
||||||
*/
|
*/
|
||||||
export function insertAt(target: string, str: string, index: number): String {
|
export function insertAt(target: string, str: string, index: number): String {
|
||||||
return `${target.slice(0, index)}${str}${target.slice(index + 1)}`;
|
return `${target.slice(0, index)}${str}${target.slice(index + 1)}`;
|
||||||
@ -150,6 +149,21 @@ export function randomStringBuilder(length: number, letters = false, numbers = f
|
|||||||
}).join('');
|
}).join('');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Splice a string together (Similar to Array.splice)
|
||||||
|
*
|
||||||
|
* @param {string} str String that will be modified
|
||||||
|
* @param {number} start Start index of splice
|
||||||
|
* @param {number} deleteCount Number of characters to remove in splice
|
||||||
|
* @param {string} insert Insert new string into splice
|
||||||
|
* @return {string} Returned spliced string
|
||||||
|
*/
|
||||||
|
export function strSplice(str: string, start: number, deleteCount: number, insert = '') {
|
||||||
|
const before = str.slice(0, start);
|
||||||
|
const after = str.slice(start + deleteCount);
|
||||||
|
return before + insert + after;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Find all substrings that match a given pattern.
|
* Find all substrings that match a given pattern.
|
||||||
*
|
*
|
||||||
@ -195,6 +209,7 @@ export type ParsedUrl = {
|
|||||||
*
|
*
|
||||||
* @param {string} url URL string that will be parsed
|
* @param {string} url URL string that will be parsed
|
||||||
* @returns {RegExpExecArray} Parts of URL
|
* @returns {RegExpExecArray} Parts of URL
|
||||||
|
* @deprecated Use built-in URL object: `new URL('...')`;
|
||||||
*/
|
*/
|
||||||
export function parseUrl(url: string): ParsedUrl {
|
export function parseUrl(url: string): ParsedUrl {
|
||||||
const processed = new RegExp(
|
const processed = new RegExp(
|
||||||
|
164
src/time.ts
164
src/time.ts
@ -1,17 +1,161 @@
|
|||||||
|
import {strSplice} from './string.ts';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return date formated highest to lowest: YYYY-MM-DD H:mm AM
|
* Like setInterval but will adjust the timeout value to account for runtime
|
||||||
|
* @param {Function} cb Callback function that will be ran
|
||||||
|
* @param {number} ms Run function ever x seconds
|
||||||
|
* @return {() => void}
|
||||||
|
*/
|
||||||
|
export function adjustedInterval(cb: Function, ms: number) {
|
||||||
|
let cancel = false, timeout: any = null;
|
||||||
|
const p = async () => {
|
||||||
|
if (cancel) return;
|
||||||
|
const start = new Date().getTime();
|
||||||
|
await cb();
|
||||||
|
const end = new Date().getTime();
|
||||||
|
timeout = setTimeout(() => p(), ms - (end - start) || 1);
|
||||||
|
};
|
||||||
|
p();
|
||||||
|
return () => {
|
||||||
|
cancel = true;
|
||||||
|
if(timeout) clearTimeout(timeout);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Format date
|
||||||
*
|
*
|
||||||
* @param {Date | number | string} date Date or timestamp to convert to string
|
* @param {Date | number | string} date Date or timestamp to convert to string
|
||||||
|
* @param {string} format How date string will be formatted, default: `YYYY-MM-DD H:mm A`
|
||||||
* @return {string} Formated date
|
* @return {string} Formated date
|
||||||
*/
|
*/
|
||||||
export function formatDate(date: Date | number | string): string {
|
export function formatDate(date: Date | number | string, format = 'YYYY-MM-DD H:mm '): string {
|
||||||
if(typeof date == 'number' || typeof date == 'string') date = new Date(date);
|
if(typeof date == 'number' || typeof date == 'string') date = new Date(date);
|
||||||
let hours = date.getHours(), postfix = 'AM';
|
|
||||||
if(hours >= 12) {
|
function day(num: number): string {
|
||||||
if(hours > 12) hours -= 12;
|
switch(num) {
|
||||||
postfix = 'PM';
|
case(0): return 'Sunday';
|
||||||
} else if(hours == 0) hours = 12;
|
case(1): return 'Monday';
|
||||||
return `${date.getFullYear()}-${(date.getMonth() + 1).toString().padStart(2, '0')}-${date.getDate().toString().padStart(2, '0')}, ${hours}:${date.getMinutes().toString().padStart(2, '0')} ${postfix}`;
|
case(2): return 'Tuesday';
|
||||||
|
case(3): return 'Wednesday';
|
||||||
|
case(4): return 'Thursday';
|
||||||
|
case(5): return 'Friday';
|
||||||
|
case(6): return 'Saturday';
|
||||||
|
default: return 'Unknown';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function doy(date: Date) {
|
||||||
|
const start = new Date(`${date.getFullYear()}-01-01 0:00:00`);
|
||||||
|
return Math.ceil((date.getTime() - start.getTime()) / (1000 * 60 * 60 * 24));
|
||||||
|
}
|
||||||
|
|
||||||
|
function month(num: number): string {
|
||||||
|
switch(num) {
|
||||||
|
case(0): return 'January';
|
||||||
|
case(1): return 'February';
|
||||||
|
case(2): return 'March';
|
||||||
|
case(3): return 'April';
|
||||||
|
case(4): return 'May';
|
||||||
|
case(5): return 'June';
|
||||||
|
case(6): return 'July';
|
||||||
|
case(7): return 'August';
|
||||||
|
case(8): return 'September';
|
||||||
|
case(9): return 'October';
|
||||||
|
case(10): return 'November';
|
||||||
|
case(11): return 'December';
|
||||||
|
default: return 'Unknown';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function suffix(num: number) {
|
||||||
|
let n = num.toString();
|
||||||
|
switch(n.at(-1)) {
|
||||||
|
case('1'): return num + 'st';
|
||||||
|
case('2'): return num + 'nd';
|
||||||
|
case('3'): return num + 'rd';
|
||||||
|
default: return num + 'th';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function tzOffset(offset: number) {
|
||||||
|
const hours = ~~(offset / 60);
|
||||||
|
const minutes = offset % 60;
|
||||||
|
return (offset > 0 ? '-' : '') + `${hours}:${minutes.toString().padStart(2, '0')}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
function timezone(offset: number) {
|
||||||
|
const hours = offset / 60;
|
||||||
|
switch (hours) {
|
||||||
|
case -12: return "IDLW";
|
||||||
|
case -11: return "SST";
|
||||||
|
case -10: return "HST";
|
||||||
|
case -9: return "AKST";
|
||||||
|
case -8: return "PST";
|
||||||
|
case -7: return "MST";
|
||||||
|
case -6: return "CST";
|
||||||
|
case -5: return "EST";
|
||||||
|
case -4: return "AST";
|
||||||
|
case -3: return "ART";
|
||||||
|
case -2: return "FNT";
|
||||||
|
case -1: return "AZOT";
|
||||||
|
case 0: return "UTC";
|
||||||
|
case 1: return "CET";
|
||||||
|
case 2: return "EET";
|
||||||
|
case 3: return "MSK";
|
||||||
|
case 4: return "SAMT";
|
||||||
|
case 5: return "YEKT";
|
||||||
|
case 6: return "OMST";
|
||||||
|
case 7: return "KRAT";
|
||||||
|
case 8: return "CST";
|
||||||
|
case 9: return "JST";
|
||||||
|
case 10: return "AEST";
|
||||||
|
case 11: return "SBT";
|
||||||
|
case 12: return "NZST";
|
||||||
|
default: return '';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return format
|
||||||
|
// Year
|
||||||
|
.replaceAll('YYYY', date.getFullYear().toString())
|
||||||
|
.replaceAll('YY', date.getFullYear().toString().slice(2))
|
||||||
|
// Month
|
||||||
|
.replaceAll('MMMM', month(date.getMonth()))
|
||||||
|
.replaceAll('MMM', month(date.getMonth()).slice(0, 2))
|
||||||
|
.replaceAll('MM', (date.getMonth() + 1).toString().padStart(2, '0'))
|
||||||
|
.replaceAll('M', (date.getMonth() + 1).toString())
|
||||||
|
// Day
|
||||||
|
.replaceAll('DDD', doy(date).toString())
|
||||||
|
.replaceAll('DD', date.getDate().toString().padStart(2, '0'))
|
||||||
|
.replaceAll('Do', suffix(date.getDate()))
|
||||||
|
.replaceAll('D', date.getDate().toString())
|
||||||
|
.replaceAll('dddd', day(date.getDay()))
|
||||||
|
.replaceAll('ddd', day(date.getDay()).slice(0, 2))
|
||||||
|
.replaceAll('dd', date.getDate().toString().padStart(2, '0'))
|
||||||
|
.replaceAll('d', date.getDay().toString())
|
||||||
|
// Hour
|
||||||
|
.replaceAll('HH', date.getHours().toString().padStart(2, '0'))
|
||||||
|
.replaceAll('H', date.getHours().toString())
|
||||||
|
.replaceAll('hh', (date.getHours() > 12 ? date.getHours() - 12 : date.getHours()).toString().padStart(2, '0'))
|
||||||
|
.replaceAll('h', (date.getHours() > 12 ? date.getHours() - 12 : date.getHours()).toString())
|
||||||
|
// Minute
|
||||||
|
.replaceAll('mm', date.getMinutes().toString().padStart(2, '0'))
|
||||||
|
.replaceAll('m', date.getMinutes().toString())
|
||||||
|
// Second
|
||||||
|
.replaceAll('ss', date.getSeconds().toString().padStart(2, '0'))
|
||||||
|
.replaceAll('s', date.getSeconds().toString())
|
||||||
|
// Millisecond
|
||||||
|
.replaceAll('SSS', date.getMilliseconds().toString())
|
||||||
|
.replaceAll('SS', date.getMilliseconds().toString().slice(0, 1))
|
||||||
|
.replaceAll('S', date.getMilliseconds().toString()[0])
|
||||||
|
// Period/Meridian (AM/PM)
|
||||||
|
.replaceAll('A', date.getHours() >= 12 ? 'PM' : 'AM')
|
||||||
|
.replaceAll('a', date.getHours() >= 12 ? 'pm' : 'am')
|
||||||
|
// Timezone
|
||||||
|
.replaceAll('ZZ', tzOffset(date.getTimezoneOffset()).replace(':', ''))
|
||||||
|
.replaceAll('Z', tzOffset(date.getTimezoneOffset()))
|
||||||
|
.replaceAll('z', timezone(date.getTimezoneOffset()));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -36,14 +180,14 @@ export function sleep(ms: number): Promise<void> {
|
|||||||
* ```js
|
* ```js
|
||||||
* let loading = true;
|
* let loading = true;
|
||||||
* setTimeout(() => wait = false, 1000);
|
* 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 {() => boolean | Promise<boolean>} fn Return true to continue
|
||||||
* @param {number} checkInterval Run function ever x milliseconds
|
* @param {number} checkInterval Run function ever x milliseconds
|
||||||
* @return {Promise<void>} Callback when sleep is over
|
* @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);
|
while(await fn()) await sleep(checkInterval);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -15,6 +15,6 @@
|
|||||||
*
|
*
|
||||||
* @return {Array<keyof T>} Available keys
|
* @return {Array<keyof T>} Available keys
|
||||||
*/
|
*/
|
||||||
export function tyoeKeys<T extends object>() {
|
export function typeKeys<T extends object>() {
|
||||||
return Object.keys(<T>{}) as Array<keyof T>;
|
return Object.keys(<T>{}) as Array<keyof T>;
|
||||||
}
|
}
|
||||||
|
@ -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