Compare commits
44 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 435be31347 | |||
| 2522635815 | |||
| e8fdca8236 | |||
| 67ae86d69b | |||
| 87db4d4755 | |||
| 0fb1e13ba0 | |||
| ff4401934c | |||
| ce3c8d012a | |||
| a86e8350ee | |||
| 7b4e17e4c4 | |||
| fa66820c76 | |||
| 49a2df8cd4 | |||
| ccf3fcb043 | |||
| 341ef37205 | |||
| 0eab2630ad | |||
| 2f59a9d02e | |||
| ce2f32dd45 | |||
| 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 |
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
|
||||
36
index.html
Normal file
36
index.html
Normal file
@ -0,0 +1,36 @@
|
||||
<!Doctype html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<title>@ztimson/utils sandbox</title>
|
||||
</head>
|
||||
<body>
|
||||
<script type="module">
|
||||
import {ArgParser} from './dist/index.mjs';
|
||||
|
||||
const hostname = 'test';
|
||||
const argParser = new ArgParser('botnet-manager.js', 'Connect & manage a network of servers to launch distributed attacks.', [
|
||||
new ArgParser('copy', 'Copy file & dependencies to botnet', [
|
||||
{name: 'file', desc: 'File to copy', default: false},
|
||||
{name: 'control', desc: 'Copy to master server', flags: ['-c', '--control'], default: false},
|
||||
{name: 'noDeps', desc: 'Skip copying dependencies', flags: ['-d', '--no-deps'], default: false},
|
||||
{name: 'slave', desc: 'Copy to slave servers', flags: ['-s', '--slave'], default: false},
|
||||
]),
|
||||
new ArgParser('join', 'Connect server as a botnet slave', [
|
||||
{name: 'device', desc: 'Device to connect, defaults to the current machine', optional: true, default: hostname}
|
||||
]),
|
||||
new ArgParser('kill', 'Kill any scripts running on the botnet'),
|
||||
new ArgParser('leave', 'Disconnect worker node from swarm', [
|
||||
{name: 'device', desc: 'Device to disconnect, defaults to the current machine', optional: true, default: hostname}
|
||||
]),
|
||||
new ArgParser('run', 'Copy & run script on the botnet', [
|
||||
{name: 'script', desc: 'Script to copy & execute', type: 'string'},
|
||||
{name: 'args', desc: 'Arguments for script. Forward the current target with: {{TARGET}}', optional: true, extras: true},
|
||||
]),
|
||||
new ArgParser('start', 'Start this server as the botnet manager'),
|
||||
{name: 'silent', desc: 'Suppress program output', flags: ['-s', '--silent'], default: false},
|
||||
]);
|
||||
console.log(argParser.help({}));
|
||||
</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",
|
||||
"version": "0.18.1",
|
||||
"version": "0.23.3",
|
||||
"description": "Utility library",
|
||||
"author": "Zak Timson",
|
||||
"license": "MIT",
|
||||
@ -38,8 +38,5 @@
|
||||
},
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"dependencies": {
|
||||
"var-persist": "^1.0.1"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
140
src/arg-parser.ts
Normal file
140
src/arg-parser.ts
Normal file
@ -0,0 +1,140 @@
|
||||
export type Arg<T = any> = {
|
||||
/** Argument/property name */
|
||||
name: string;
|
||||
/** Argument description for help page */
|
||||
desc: string;
|
||||
/** Available shorthands */
|
||||
flags?: string[];
|
||||
/** Argument is not required */
|
||||
optional?: boolean;
|
||||
/** Default value if argument is not used */
|
||||
default?: T;
|
||||
/** Collects any unmatched arguments */
|
||||
extras?: boolean;
|
||||
}
|
||||
|
||||
export class ArgParser {
|
||||
commands: ArgParser[] = [];
|
||||
args: Arg[] = [];
|
||||
flags: Arg[] = [];
|
||||
defaults!: {[key: string]: any};
|
||||
|
||||
/**
|
||||
* Create a unix-like argument parser to extract flags from the argument list. Can also create help messages.
|
||||
*
|
||||
* @param {string} name Script name
|
||||
* @param {string} desc Help description
|
||||
* @param {(ArgParser | Arg[]} argList Array of CLI arguments
|
||||
* @param {string[]} examples Additional examples to display
|
||||
*/
|
||||
constructor(public readonly name: string,
|
||||
public readonly desc: string,
|
||||
public readonly argList: (ArgParser | Arg)[] = [],
|
||||
public readonly examples: string[] = []
|
||||
) {
|
||||
// Arguments
|
||||
this.commands = argList.filter(arg => arg instanceof ArgParser);
|
||||
this.args = <Arg[]>argList.filter(arg => !(arg instanceof ArgParser) && !arg.flags?.length);
|
||||
this.flags = <Arg[]>[...argList.filter(arg => !(arg instanceof ArgParser) && arg.flags && arg.flags.length), ...this.flags];
|
||||
this.defaults = argList.reduce((acc, arg: any) => ({...acc, [arg.name]: arg['extras'] ? [] : (arg.default ?? null)}), {});
|
||||
|
||||
// Examples
|
||||
this.examples = <string[]>[
|
||||
...examples,
|
||||
`[OPTIONS] ${this.args.map(arg => (arg.optional ? `[${arg.name.toUpperCase()}]` : arg.name.toUpperCase()) + (arg.extras ? '...' : '')).join(' ')}`,
|
||||
this.commands.length ? `[OPTIONS] COMMAND` : null,
|
||||
`--help ${this.commands.length ? '[COMMAND]' : ''}`
|
||||
].filter(e => !!e);
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse an array into an arguments dictionary using the configuration.
|
||||
*
|
||||
* @param {string[]} args Array of arguments to be parsed
|
||||
* @returns {object} Dictionary of arguments with defaults applied
|
||||
*/
|
||||
parse(args: string[]) {
|
||||
// Parse arguments
|
||||
let extras = [], parsed: any = {...this.defaults, '_error': []}, queue = [...args];
|
||||
while(queue.length) {
|
||||
let arg = queue.splice(0, 1)[0];
|
||||
if(arg[0] == '-') { // Flags
|
||||
// Check for combined shorthand
|
||||
if(arg[1] != '-' && arg.length > 2) {
|
||||
queue = [...arg.substring(2).split('').map(a => `-${a}`), ...queue];
|
||||
arg = `-${arg[1]}`;
|
||||
}
|
||||
// Find & add flag
|
||||
const combined = arg.split('=');
|
||||
const argDef = this.flags.find(flag => flag.flags?.includes(combined[0] || arg));
|
||||
if(argDef == null) { // Not found, add to extras
|
||||
extras.push(arg);
|
||||
continue;
|
||||
}
|
||||
const value = argDef.default === false ? true :
|
||||
argDef.default === true ? false :
|
||||
queue.splice(queue.findIndex(q => q[0] != '-'), 1)[0] ||
|
||||
argDef.default;
|
||||
if(value == null) parsed['_error'].push(`Option missing value: ${argDef.name || combined[0]}`);
|
||||
parsed[argDef.name] = value;
|
||||
} else { // Command
|
||||
const c = this.commands.find(command => command.name == arg);
|
||||
if(!!c) {
|
||||
const parsedCommand = c.parse(queue.splice(0, queue.length));
|
||||
Object.keys(parsedCommand).forEach(key => {
|
||||
if(parsed[key] != parsedCommand[key] && parsedCommand[key] == c.defaults[key])
|
||||
delete parsedCommand[key];
|
||||
});
|
||||
parsed = {
|
||||
...parsed,
|
||||
...parsedCommand,
|
||||
_command: c.name
|
||||
};
|
||||
} else extras.push(arg); // Not found, add to extras
|
||||
}
|
||||
}
|
||||
// Arguments
|
||||
this.args.filter(arg => !arg.extras).forEach(arg => {
|
||||
if(!arg.optional && !extras.length) parsed['_error'].push(`Argument missing: ${arg.name.toUpperCase()}`);
|
||||
if(extras.length) parsed[arg.name] = extras.splice(0, 1)[0];
|
||||
});
|
||||
// Extras
|
||||
const extraKey = this.args.find(arg => arg.extras)?.name || '_extra';
|
||||
parsed[extraKey] = extras;
|
||||
return parsed;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create help message from the provided description & argument list.
|
||||
*
|
||||
* @returns {string} Help message
|
||||
* @param opts Help options: command - display a commands help, message - override help description
|
||||
*/
|
||||
help(opts: {command?: string, message?: string} = {}): string {
|
||||
const spacer = (text: string) => Array(24 - text.length || 1).fill(' ').join('');
|
||||
|
||||
// Help with specific command
|
||||
if(opts.command) {
|
||||
const argParser = this.commands.find(parser => parser.name == opts.command);
|
||||
if(!argParser) throw new Error(`${opts.command.toUpperCase()} is not a command`)
|
||||
return argParser.help({...opts, command: undefined});
|
||||
}
|
||||
|
||||
// Description
|
||||
let msg = `\n\n${opts.message || this.desc}`;
|
||||
// Examples
|
||||
msg += '\n\nUsage:\t' + this.examples.map(ex => `run ${this.name} ${ex}`).join('\n\t\t');
|
||||
// Arguments
|
||||
if(this.args.length) msg += '\n\n\t\t' + this.args.map(arg =>
|
||||
`${arg.name.toUpperCase()}${spacer(arg.name)}${arg.desc}`).join('\n\t\t');
|
||||
// Flags
|
||||
msg += '\n\nOptions:\n\t\t' + this.flags.map(flag => {
|
||||
const flags = flag.flags?.join(', ') || '';
|
||||
return `${flags}${spacer(flags)}${flag.desc}`;
|
||||
}).join('\n\t\t');
|
||||
// Commands
|
||||
if(this.commands.length) msg += '\n\nCommands:\n\t\t' + this.commands.map(command =>
|
||||
`${command.name}${spacer(command.name)}${command.desc}`).join('\n\t\t');
|
||||
return `${msg}\n\n`;
|
||||
}
|
||||
}
|
||||
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
|
||||
* and provides set functions for comparisons
|
||||
@ -24,6 +26,7 @@ export class ASet<T> extends Array {
|
||||
*/
|
||||
add(...items: T[]) {
|
||||
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[]) {
|
||||
items.forEach(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;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @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
|
||||
*/
|
||||
@ -13,9 +22,18 @@ export class Cache<K extends string | number | symbol, 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 && 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];
|
||||
@ -69,6 +87,13 @@ export class Cache<K extends string | number | symbol, T> {
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove all keys from cache
|
||||
*/
|
||||
clear() {
|
||||
this.store = <Record<K, T>>{};
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete an item from the cache
|
||||
*
|
||||
@ -76,6 +101,8 @@ export class Cache<K extends string | number | symbol, 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));
|
||||
}
|
||||
|
||||
/**
|
||||
@ -118,15 +145,17 @@ export class Cache<K extends string | number | symbol, T> {
|
||||
*
|
||||
* @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;
|
||||
}
|
||||
|
||||
|
||||
52
src/csv.ts
52
src/csv.ts
@ -1,4 +1,41 @@
|
||||
import {dotNotation, flattenObj} from './objects.ts';
|
||||
import {ASet} from './aset.ts';
|
||||
import {dotNotation, flattenObj, JSONSanitize} from './objects.ts';
|
||||
import {LETTER_LIST} from './string.ts';
|
||||
|
||||
export function fromCsv<T = any>(csv: string, hasHeaders=true): T[] {
|
||||
const row = csv.split('\n');
|
||||
let headers: any = hasHeaders ? row.splice(0, 1)[0] : null;
|
||||
if(headers) headers = headers.match(/(?:[^,"']+|"[^"]*"|'[^']*')+/g);
|
||||
return <T[]>row.map(r => {
|
||||
function parseLine(line: string): (string | null)[] {
|
||||
const parts = line.split(','), columns: string[] = [];
|
||||
let quoted = false;
|
||||
for(const p of parts) {
|
||||
if(quoted) columns[columns.length - 1] = columns.at(-1) + ',' + p;
|
||||
else columns.push(p);
|
||||
if(/[^"]"$/g.test(p)) {
|
||||
quoted = false;
|
||||
} else if(/^"[^"]/g.test(p)) {
|
||||
quoted = true;
|
||||
}
|
||||
}
|
||||
return columns;
|
||||
}
|
||||
|
||||
const props = parseLine(r);
|
||||
const h = headers || (Array(props.length).fill(null).map((r, i) => {
|
||||
let letter = '';
|
||||
const first = i / 26;
|
||||
if(first > 1) letter += LETTER_LIST[Math.floor(first - 1)];
|
||||
letter += LETTER_LIST[i % 26];
|
||||
return letter;
|
||||
}));
|
||||
return h.reduce((acc: any, h: any, i: number) => {
|
||||
dotNotation(acc, h, props[i]);
|
||||
return acc;
|
||||
}, {});
|
||||
})
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert an object to a CSV string
|
||||
@ -7,20 +44,13 @@ import {dotNotation, flattenObj} from './objects.ts';
|
||||
* @param {boolean} flatten Should nested object be flattened or treated as values
|
||||
* @return {string} CSV string
|
||||
*/
|
||||
export function csv(target: any[], flatten=true) {
|
||||
const headers = target.reduce((acc, row) => {
|
||||
Object.keys(flatten ? flattenObj(row) : row)
|
||||
.forEach(key => { if(!acc.includes(key)) acc.push(key); });
|
||||
return acc;
|
||||
}, []);
|
||||
export function toCsv(target: any[], flatten=true) {
|
||||
const headers = new ASet(target.reduce((acc, row) => [...acc, ...Object.keys(flatten ? flattenObj(row) : row)], []));
|
||||
return [
|
||||
headers.join(','),
|
||||
...target.map(row => headers.map((h: string) => {
|
||||
const value = dotNotation<any>(row, h);
|
||||
const type = typeof value;
|
||||
if(type == 'string' && value.includes(',')) return `"${value}"`;
|
||||
if(type == 'object') return `"${JSON.stringify(value)}"`;
|
||||
return value;
|
||||
return (typeof value == 'object' && value != null) ? '"' + JSONSanitize(value).replaceAll('"', '""') + '"' : value;
|
||||
}).join(','))
|
||||
].join('\n');
|
||||
}
|
||||
|
||||
@ -1,33 +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);
|
||||
|
||||
@ -180,7 +180,6 @@ export class GatewayTimeoutError extends CustomError {
|
||||
* @return {CustomError} The proper error type
|
||||
*/
|
||||
export function errorFromCode(code: number, message?: string) {
|
||||
if(code >= 200 && code < 300) return null;
|
||||
switch(code) {
|
||||
case 400:
|
||||
return new BadRequestError(message);
|
||||
|
||||
15
src/files.ts
15
src/files.ts
@ -52,6 +52,21 @@ export function fileBrowser(options: {accept?: string, multiple?: boolean} = {})
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract text from a file
|
||||
*
|
||||
* @param file File to extract text from
|
||||
* @return {Promise<string | null>} File contents
|
||||
*/
|
||||
export function fileText(file: any): Promise<string | null> {
|
||||
return new Promise((resolve, reject) => {
|
||||
const reader = new FileReader();
|
||||
reader.onload = () => resolve(<string>reader.result);
|
||||
reader.onerror = () => reject(reader.error);
|
||||
reader.readAsText(file);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Create timestamp intended for filenames from a date
|
||||
*
|
||||
|
||||
@ -75,6 +75,7 @@ export class Http {
|
||||
|
||||
// Send request
|
||||
return new PromiseProgress((res, rej, prog) => {
|
||||
try {
|
||||
fetch(url, {
|
||||
headers,
|
||||
method: opts.method || (opts.body ? 'POST' : 'GET'),
|
||||
@ -100,6 +101,7 @@ export class Http {
|
||||
push();
|
||||
}).catch((error: any) => controller.error(error));
|
||||
}
|
||||
|
||||
push();
|
||||
}
|
||||
});
|
||||
@ -115,7 +117,10 @@ export class Http {
|
||||
|
||||
if(resp.ok) res(resp);
|
||||
else rej(resp);
|
||||
})
|
||||
}).catch(err => rej(err));
|
||||
} catch(err) {
|
||||
rej(err);
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
export * from './arg-parser';
|
||||
export * from './array';
|
||||
export * from './aset';
|
||||
export * from './cache';
|
||||
@ -11,8 +12,9 @@ export * from './logger';
|
||||
export * from './math';
|
||||
export * from './misc';
|
||||
export * from './objects';
|
||||
export * from './path-events';
|
||||
export * from './promise-progress';
|
||||
export * from './search';
|
||||
export * from './string';
|
||||
export * from './time';
|
||||
export * from './types';
|
||||
export * from 'var-persist';
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
import {TypedEmitter, TypedEvents} from './emitter';
|
||||
import {JSONSanitize} from './objects.ts';
|
||||
|
||||
export const CliEffects = {
|
||||
CLEAR: "\x1b[0m",
|
||||
@ -64,49 +65,41 @@ export class Logger extends TypedEmitter<LoggerEvents> {
|
||||
super();
|
||||
}
|
||||
|
||||
private pad(text: any, length: number, char: string, end = false) {
|
||||
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 {
|
||||
protected format(...text: any[]): string {
|
||||
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)}`;
|
||||
return `${timestamp}${this.namespace ? ` [${this.namespace}]` : ''} ${text.join(' ')}`;
|
||||
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.map(t => typeof t == 'string' ? t : JSONSanitize(t, 2)).join(' ')}`;
|
||||
}
|
||||
|
||||
debug(...args: string[]) {
|
||||
debug(...args: any[]) {
|
||||
if(Logger.LOG_LEVEL < LOG_LEVEL.DEBUG) return;
|
||||
const str = this.format(...args);
|
||||
Logger.emit(LOG_LEVEL.DEBUG, str);
|
||||
console.debug(CliForeground.LIGHT_GREY + str + CliEffects.CLEAR);
|
||||
}
|
||||
|
||||
log(...args: string[]) {
|
||||
log(...args: any[]) {
|
||||
if(Logger.LOG_LEVEL < LOG_LEVEL.LOG) return;
|
||||
const str = this.format(...args);
|
||||
Logger.emit(LOG_LEVEL.LOG, str);
|
||||
console.log(CliEffects.CLEAR + str);
|
||||
}
|
||||
|
||||
info(...args: string[]) {
|
||||
info(...args: any[]) {
|
||||
if(Logger.LOG_LEVEL < LOG_LEVEL.INFO) return;
|
||||
const str = this.format(...args);
|
||||
Logger.emit(LOG_LEVEL.INFO, str);
|
||||
console.info(CliForeground.BLUE + str + CliEffects.CLEAR);
|
||||
}
|
||||
|
||||
warn(...args: string[]) {
|
||||
warn(...args: any[]) {
|
||||
if(Logger.LOG_LEVEL < LOG_LEVEL.WARN) return;
|
||||
const str = this.format(...args);
|
||||
Logger.emit(LOG_LEVEL.WARN, str);
|
||||
console.warn(CliForeground.YELLOW + str + CliEffects.CLEAR);
|
||||
}
|
||||
|
||||
error(...args: string[]) {
|
||||
error(...args: any[]) {
|
||||
if(Logger.LOG_LEVEL < LOG_LEVEL.ERROR) return;
|
||||
const str = this.format(...args);
|
||||
Logger.emit(LOG_LEVEL.ERROR, str);
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
import {PathEvent} from './path-events.ts';
|
||||
import {md5} from './string';
|
||||
|
||||
/**
|
||||
@ -18,6 +19,9 @@ export function gravatar(email: string, def='mp') {
|
||||
* @param {string} value String which should be escaped
|
||||
* @return {string} New escaped sequence
|
||||
*/
|
||||
function escapeRegex(value: string) {
|
||||
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.
|
||||
* @param {T} value Object to copy
|
||||
* @returns {T} Type
|
||||
* @deprecated Please use `structuredClone`
|
||||
*/
|
||||
export function deepCopy<T>(value: T): T {
|
||||
return structuredClone(value);
|
||||
try {return structuredClone(value); }
|
||||
catch { return JSON.parse(JSONSanitize(value)); }
|
||||
}
|
||||
|
||||
/**
|
||||
@ -91,7 +91,6 @@ export function dotNotation<T>(obj: any, prop: string, set?: T): T | undefined {
|
||||
}, obj);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Convert object into URL encoded query string
|
||||
*
|
||||
@ -128,8 +127,9 @@ export function encodeQuery(data: any): string {
|
||||
export function flattenObj(obj: any, parent?: any, result: any = {}) {
|
||||
if(typeof obj === "object" && !Array.isArray(obj)) {
|
||||
for(const key of Object.keys(obj)) {
|
||||
const propName = parent ? parent + '.' + key : key;
|
||||
if(typeof obj[key] === 'object') {
|
||||
const propName = parent ? `${parent}.${key}` : key;
|
||||
if(typeof obj[key] === 'object' && obj[key] != null && !Array.isArray(obj[key])) {
|
||||
console.log(propName, );
|
||||
flattenObj(obj[key], propName, result);
|
||||
} else {
|
||||
result[propName] = obj[key];
|
||||
@ -216,14 +216,25 @@ export function mixin(target: any, constructors: any[]) {
|
||||
/**
|
||||
* Parse JSON but return the original string if it fails
|
||||
*
|
||||
* @param {string} json JSON string to parse
|
||||
* @param {any} json JSON string to parse
|
||||
* @return {string | T} Object if successful, original string otherwise
|
||||
*/
|
||||
export function JSONAttemptParse<T>(json: string): T | string {
|
||||
try { return JSON.parse(json); }
|
||||
export function JSONAttemptParse<T1, T2>(json: T2): T1 | T2 {
|
||||
try { return JSON.parse(<any>json); }
|
||||
catch { return json; }
|
||||
}
|
||||
|
||||
/**
|
||||
* Stringifies objects & skips primitives
|
||||
*
|
||||
* @param {any} obj Object to convert to serializable value
|
||||
* @return {string | T} Serialized value
|
||||
*/
|
||||
export function JSONSerialize<T1>(obj: T1): T1 | string {
|
||||
if(typeof obj == 'object' && obj != null) return JSONSanitize(obj);
|
||||
return obj;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert an object to a JSON string avoiding any circular references.
|
||||
*
|
||||
@ -234,10 +245,8 @@ export function JSONAttemptParse<T>(json: string): T | string {
|
||||
export function JSONSanitize(obj: any, space?: number): string {
|
||||
let cache: any[] = [];
|
||||
return JSON.stringify(obj, (key, value) => {
|
||||
if (typeof value === 'object' && value !== null) {
|
||||
if (cache.includes(value)) return;
|
||||
cache.push(value);
|
||||
}
|
||||
if(typeof value === 'object' && value !== null)
|
||||
if(!cache.includes(value)) cache.push(value);
|
||||
return value;
|
||||
}, 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: any[]) {
|
||||
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.replaceAll(/\/{2,}/g, '/').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));
|
||||
}
|
||||
}
|
||||
38
src/search.ts
Normal file
38
src/search.ts
Normal file
@ -0,0 +1,38 @@
|
||||
import {dotNotation, JSONAttemptParse} from './objects';
|
||||
|
||||
export function search(rows: any[], search: string, regex?: boolean, transform: Function = (r: any) => r) {
|
||||
if(!rows) return [];
|
||||
return rows.filter(r => {
|
||||
// Empty search
|
||||
const value = transform(r);
|
||||
if(!search) return true;
|
||||
// Regex search
|
||||
if(regex) {
|
||||
return !!Object.values(value).filter((v: any) => {
|
||||
try { return RegExp(search, 'gm').test(v.toString()); }
|
||||
catch { return false; }
|
||||
}).length
|
||||
}
|
||||
// Make sure at least one OR passes
|
||||
const or = search.split('||').map(p => p.trim()).filter(p => !!p);
|
||||
return -1 != or.findIndex(p => {
|
||||
// Make sure all ANDs pass
|
||||
const and = p.split('&&').map(p => p.trim()).filter(p => !!p);
|
||||
return and.filter(p => {
|
||||
// Boolean operator
|
||||
const prop = /(\w+)\s*(==?|!=|>=|>|<=|<)\s*(\w+)/g.exec(p);
|
||||
if(prop) {
|
||||
const a = JSON.stringify(JSONAttemptParse(dotNotation<any>(value, prop[1])));
|
||||
const operator = prop[2] == '=' ? '==' : prop[2];
|
||||
const b = JSON.stringify(JSONAttemptParse(prop[3]));
|
||||
return eval(`${a} ${operator} ${b}`);
|
||||
}
|
||||
// Case-sensitive
|
||||
const v = Object.values(value).join('');
|
||||
if(/[A-Z]/g.test(search)) return v.includes(p);
|
||||
// Case-insensitive
|
||||
return v.toLowerCase().includes(p);
|
||||
}).length == and.length;
|
||||
})
|
||||
});
|
||||
}
|
||||
@ -1,24 +1,22 @@
|
||||
import {dotNotation, flattenObj} from './objects.ts';
|
||||
|
||||
/**
|
||||
* String of all letters
|
||||
*/
|
||||
const LETTER_LIST = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
|
||||
export const LETTER_LIST = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
|
||||
|
||||
/**
|
||||
* String of all numbers
|
||||
*/
|
||||
const NUMBER_LIST = '0123456789';
|
||||
export const NUMBER_LIST = '0123456789';
|
||||
|
||||
/**
|
||||
* String of all symbols
|
||||
*/
|
||||
const SYMBOL_LIST = '~`!@#$%^&*()_-+={[}]|\\:;"\'<,>.?/';
|
||||
export const SYMBOL_LIST = '~`!@#$%^&*()_-+={[}]|\\:;"\'<,>.?/';
|
||||
|
||||
/**
|
||||
* String of all letters, numbers & symbols
|
||||
*/
|
||||
const CHAR_LIST = LETTER_LIST + NUMBER_LIST + SYMBOL_LIST;
|
||||
export const CHAR_LIST = LETTER_LIST + LETTER_LIST.toLowerCase() + NUMBER_LIST + SYMBOL_LIST;
|
||||
|
||||
/**
|
||||
* Convert number of bytes into a human-readable size
|
||||
@ -44,7 +42,7 @@ export function formatBytes(bytes: number, decimals = 2) {
|
||||
export function formatPhoneNumber(number: string) {
|
||||
const parts = /(\+?1)?.*?(\d{3}).*?(\d{3}).*?(\d{4})/g.exec(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 {number} index - Position to inject string at
|
||||
* @returns {string} - New string
|
||||
* @deprecated use `strSplice()`
|
||||
*/
|
||||
export function insertAt(target: string, str: string, index: number): String {
|
||||
return `${target.slice(0, index)}${str}${target.slice(index + 1)}`;
|
||||
@ -150,6 +149,21 @@ export function randomStringBuilder(length: number, letters = false, numbers = f
|
||||
}).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.
|
||||
*
|
||||
@ -195,6 +209,7 @@ export type ParsedUrl = {
|
||||
*
|
||||
* @param {string} url URL string that will be parsed
|
||||
* @returns {RegExpExecArray} Parts of URL
|
||||
* @deprecated Use built-in URL object: `new URL('...')`;
|
||||
*/
|
||||
export function parseUrl(url: string): ParsedUrl {
|
||||
const processed = new RegExp(
|
||||
|
||||
183
src/time.ts
183
src/time.ts
@ -1,17 +1,184 @@
|
||||
/**
|
||||
* 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 {string} format How date string will be formatted, default: `YYYY-MM-DD H:mm A`
|
||||
* @param tz Override timezone, can be either string or number
|
||||
* @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', tz?: string | number): string {
|
||||
const timezones = [
|
||||
['IDLW', -12],
|
||||
['SST', -11],
|
||||
['HST', -10],
|
||||
['AKST', -9],
|
||||
['PST', -8],
|
||||
['MST', -7],
|
||||
['CST', -6],
|
||||
['EST', -5],
|
||||
['AST', -4],
|
||||
['BRT', -3],
|
||||
['MAT', -2],
|
||||
['AZOT', -1],
|
||||
['UTC', 0],
|
||||
['CET', 1],
|
||||
['EET', 2],
|
||||
['MSK', 3],
|
||||
['AST', 4],
|
||||
['PKT', 5],
|
||||
['IST', 5.5],
|
||||
['BST', 6],
|
||||
['ICT', 7],
|
||||
['CST', 8],
|
||||
['JST', 9],
|
||||
['AEST', 10],
|
||||
['SBT', 11],
|
||||
['FJT', 12],
|
||||
['TOT', 13],
|
||||
['LINT', 14]
|
||||
];
|
||||
|
||||
function adjustTz(date: Date, gmt: number) {
|
||||
const currentOffset = date.getTimezoneOffset();
|
||||
const adjustedOffset = gmt * 60;
|
||||
return new Date(date.getTime() + (adjustedOffset + currentOffset) * 60000);
|
||||
}
|
||||
|
||||
function day(num: number): string {
|
||||
switch(num) {
|
||||
case(0): return 'Sunday';
|
||||
case(1): return 'Monday';
|
||||
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')}`;
|
||||
}
|
||||
|
||||
if(typeof date == 'number' || typeof date == 'string') date = new Date(date);
|
||||
let hours = date.getHours(), postfix = 'AM';
|
||||
if(hours >= 12) {
|
||||
if(hours > 12) hours -= 12;
|
||||
postfix = 'PM';
|
||||
} else if(hours == 0) hours = 12;
|
||||
return `${date.getFullYear()}-${(date.getMonth() + 1).toString().padStart(2, '0')}-${date.getDate().toString().padStart(2, '0')}, ${hours}:${date.getMinutes().toString().padStart(2, '0')} ${postfix}`;
|
||||
|
||||
// Handle timezones
|
||||
let t!: [string, number];
|
||||
if(tz == null) tz = -(date.getTimezoneOffset() / 60);
|
||||
t = <any>timezones.find(t => isNaN(<any>tz) ? t[0] == tz : t[1] == tz);
|
||||
if(!t) throw new Error(`Unknown timezone: ${tz}`);
|
||||
date = adjustTz(date, t[1]);
|
||||
|
||||
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, 3))
|
||||
.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().padEnd(3, '0'))
|
||||
.replaceAll('SS', date.getMilliseconds().toString().slice(0, 1).padEnd(2, '0'))
|
||||
.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(t[1] * 60).replace(':', ''))
|
||||
.replaceAll('Z', tzOffset(t[1] * 60))
|
||||
.replaceAll('z', typeof tz == 'string' ? tz : (<any>t)[0]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Run a function immediately & repeat every x ms
|
||||
*
|
||||
* @param {() => any} fn Callback function
|
||||
* @param {number} interval Repeat in ms
|
||||
* @return {number} Clear Interval ID
|
||||
*/
|
||||
export function instantInterval(fn: () => any, interval: number) {
|
||||
fn();
|
||||
return setInterval(fn, interval);
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@ -15,6 +15,6 @@
|
||||
*
|
||||
* @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>;
|
||||
}
|
||||
|
||||
@ -13,7 +13,7 @@ export default defineConfig({
|
||||
}
|
||||
},
|
||||
emptyOutDir: true,
|
||||
minify: true,
|
||||
minify: false,
|
||||
sourcemap: true
|
||||
},
|
||||
plugins: [dts()],
|
||||
|
||||
Reference in New Issue
Block a user