Compare commits
152 Commits
Author | SHA1 | Date | |
---|---|---|---|
9a0f32323e | |||
f952abc95a | |||
21fc1378b8 | |||
a03567eba3 | |||
f9fc4fb7ff | |||
ff16f3bf9b | |||
e0085ecb6f | |||
1c2c18b65d | |||
cd5741d6ab | |||
5b9e0714ce | |||
a3b34ef03f | |||
f755d8f5b8 | |||
35c471eef4 | |||
fe9fdb9384 | |||
a5d7a35fdc | |||
cb117273a7 | |||
3bda688b1e | |||
446b1aa9db | |||
30be1c5a91 | |||
6b328e64ba | |||
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 | |||
e4229296c1 | |||
b93ed45521 | |||
3e8f5cc00b | |||
54a2880391 | |||
b7aeee4706 | |||
b3eab0d6c9 | |||
ad4194a981 | |||
e1f22a01a6 | |||
91c0858d9f | |||
8094b6507f | |||
e40f410830 | |||
c1043e65e2 | |||
67d9928a61 | |||
e6636d373b | |||
811d797e1b | |||
0909c4f648 | |||
8384d6a299 | |||
19251244d2 | |||
51549db3d9 | |||
3bf8c7bd09 | |||
e8e56a3f72 | |||
98f867ed4e | |||
94cea19728 | |||
3896949fc1 | |||
a0f0699a85 | |||
adcd6eaf79 | |||
afb6ca0803 | |||
e699f8a634 | |||
c7dd91e9cd | |||
20f36cc573 | |||
57446ef09a | |||
6d13df39f5 | |||
2d63db0ebb | |||
535fc0271e | |||
d587b92ea4 | |||
26c6084052 | |||
874bba59d3 | |||
948fba3a2c | |||
a168b03caf | |||
75160b7dbc | |||
af887a0bfb | |||
7626c20f08 | |||
6998616445 | |||
627757ff6d | |||
0a775f919b | |||
7063b80bdd | |||
f3049160b6 | |||
e21273ddb2 | |||
8d3b427c1b | |||
87857a01c5 | |||
535e579b43 | |||
2934f86530 | |||
0693397164 | |||
2a878b7962 | |||
7b2d4ba119 | |||
1a4e732fd5 | |||
3a039c935f | |||
ac5b0b8b41 | |||
3f85c9cf7d | |||
1eff60e7dd | |||
1d9ad2ef63 | |||
973a884b3e | |||
6f60f8bd94 | |||
07606cd996 | |||
3ca956e531 | |||
9350c837e5 | |||
86196c3feb | |||
0985ff145e | |||
7cd717fc7d | |||
2fe8cdb96a | |||
34c2df7a1a | |||
1d5509a078 | |||
9f57b93a9f | |||
d0e9cbcaa6 | |||
67b314b507 | |||
f5d66f0d8f | |||
18c4366866 | |||
d9844797ec | |||
9ae28849e3 | |||
7324e89ad8 | |||
65f8414a5c | |||
86d2d34615 | |||
be8c297c47 | |||
85fc5f3017 | |||
c8ccc19996 | |||
77e6a40261 | |||
3deb536323 | |||
f6b0e63751 |
67
.github/workflows/build.yaml
vendored
67
.github/workflows/build.yaml
vendored
@ -9,39 +9,28 @@ jobs:
|
||||
build:
|
||||
name: Build NPM Project
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: node
|
||||
volumes:
|
||||
- '/mnt/swarm/gitea/runner/cache:/cache'
|
||||
container: node:20-alpine
|
||||
steps:
|
||||
- name: Clone Repository
|
||||
uses: ztimson/actions/clone@develop
|
||||
|
||||
- name: Restore node_modules
|
||||
uses: ztimson/actions/cache/restore@develop
|
||||
with:
|
||||
key: node_modules
|
||||
|
||||
- name: Install Dependencies
|
||||
run: npm i
|
||||
|
||||
- name: Build Project
|
||||
run: npm run build
|
||||
- name: Install & Build
|
||||
run: |
|
||||
npm i
|
||||
npm run build
|
||||
|
||||
- name: Test
|
||||
run: npm run test:coverage
|
||||
|
||||
- name: Cache node_modules
|
||||
uses: ztimson/actions/cache@develop
|
||||
with:
|
||||
key: node_modules
|
||||
pattern: node_modules
|
||||
- name: Upload to Registry
|
||||
uses: ztimson/actions/npm/publish@develop
|
||||
|
||||
- name: Cache Artifacts
|
||||
uses: ztimson/actions/cache@develop
|
||||
- name: Upload to NPM
|
||||
uses: ztimson/actions/npm/publish@develop
|
||||
with:
|
||||
key: dist
|
||||
pattern: dist
|
||||
owner: ztimson
|
||||
registry: https://registry.npmjs.org/
|
||||
token: ${{secrets.NPM_TOKEN}}
|
||||
tag:
|
||||
name: Tag Version
|
||||
needs: build
|
||||
@ -60,30 +49,12 @@ jobs:
|
||||
with:
|
||||
tag: ${{env.VERSION}}
|
||||
|
||||
publish:
|
||||
name: Publish
|
||||
|
||||
docs:
|
||||
name: Publish Documentation
|
||||
needs: build
|
||||
if: ${{github.ref_name}} == 'release'
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: node
|
||||
volumes:
|
||||
- '/mnt/swarm/gitea/runner/cache:/cache'
|
||||
steps:
|
||||
- name: Clone Repository
|
||||
uses: ztimson/actions/clone@develop
|
||||
|
||||
- name: Restore Artifacts
|
||||
uses: ztimson/actions/cache/restore@develop
|
||||
uses: ztimson/actions/.github/workflows/docker.yaml@develop
|
||||
with:
|
||||
key: dist
|
||||
|
||||
- name: Upload to Registry
|
||||
uses: ztimson/actions/npm/publish@develop
|
||||
|
||||
- name: Upload to NPM
|
||||
uses: ztimson/actions/npm/publish@develop
|
||||
with:
|
||||
owner: ztimson
|
||||
registry: https://registry.npmjs.org/
|
||||
token: ${{secrets.NPM_TOKEN}}
|
||||
name: ztimson/utils
|
||||
repository: ${{github.server_url}}/${{github.repository}}.git
|
||||
pass: ${{secrets.DEPLOY_TOKEN}}
|
||||
|
5
.gitmodules
vendored
Normal file
5
.gitmodules
vendored
Normal file
@ -0,0 +1,5 @@
|
||||
[submodule "docs"]
|
||||
path = docs
|
||||
url = git@git.zakscode.com:ztimson/utils.wiki.git
|
||||
branch = master
|
||||
ignore = all
|
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
|
91
README.md
Normal file
91
README.md
Normal file
@ -0,0 +1,91 @@
|
||||
<!-- Header -->
|
||||
<div id="top" align="center">
|
||||
<br />
|
||||
|
||||
<!-- Logo -->
|
||||
<img src="https://git.zakscode.com/repo-avatars/77dbab78e5fb3302dc9e751c4d6315a64df8d3a714d5cd5719b0dc39e6619119" alt="Logo" width="200" height="200">
|
||||
|
||||
<!-- Title -->
|
||||
### @ztimson/utils
|
||||
|
||||
<!-- Description -->
|
||||
Javascript/Typescript Utilities
|
||||
|
||||
<!-- Repo badges -->
|
||||
[](https://git.zakscode.com/ztimson/utils/tags)
|
||||
[](https://git.zakscode.com/ztimson/utils/pulls)
|
||||
[](https://git.zakscode.com/ztimson/utils/issues)
|
||||
|
||||
<!-- Links -->
|
||||
|
||||
---
|
||||
<div>
|
||||
<a href="https://utils.docs.zakscode.com" target="_blank">Documentation</a>
|
||||
• <a href="https://git.zakscode.com/ztimson/utils/releases" target="_blank">Release Notes</a>
|
||||
• <a href="https://git.zakscode.com/ztimson/utils/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
|
||||
• <a href="https://git.zakscode.com/ztimson/utils/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
|
||||
</div>
|
||||
|
||||
---
|
||||
</div>
|
||||
|
||||
## Table of Contents
|
||||
- [@ztimson/utils](#top)
|
||||
- [About](#about)
|
||||
- [Built With](#built-with)
|
||||
- [Setup](#setup)
|
||||
- [Production](#production)
|
||||
- [Development](#development)
|
||||
- [Documentation](https://utils.docs.zakscode.com/)
|
||||
- [License](#license)
|
||||
|
||||
## About
|
||||
|
||||
A collection of utilities to make life a little easier
|
||||
|
||||
### Built With
|
||||
[](https://typescriptlang.org/)
|
||||
|
||||
## Setup
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
<h3 id="production" style="display: inline">
|
||||
Production
|
||||
</h3>
|
||||
</summary>
|
||||
|
||||
#### Prerequisites
|
||||
- [Node.js](https://nodejs.org/en/download)
|
||||
|
||||
#### Instructions
|
||||
1. Install persist: `npm i @ztimosn/utils`
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
<h3 id="development" style="display: inline">
|
||||
Development
|
||||
</h3>
|
||||
</summary>
|
||||
|
||||
#### Prerequisites
|
||||
- [Node.js](https://nodejs.org/en/download)
|
||||
|
||||
#### Instructions
|
||||
1. Install the dependencies: `npm i`
|
||||
2. Build library: `npm build`
|
||||
3. Run unit tests: `npm test`
|
||||
|
||||
</details>
|
||||
|
||||
## Documentation
|
||||
|
||||
[Available Here](https://utils.docs.zakscode.com/)
|
||||
|
||||
## License
|
||||
|
||||
Copyright © 2023 Zakary Timson | Available under MIT Licensing
|
||||
|
||||
See the [license](_media/LICENSE) for more information.
|
1
docs
Submodule
1
docs
Submodule
@ -0,0 +1 @@
|
||||
Subproject commit dbf5d8cd076d8ddbf4e4b1b1e0c0c301270303dd
|
15
index.html
Normal file
15
index.html
Normal file
@ -0,0 +1,15 @@
|
||||
<!Doctype html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<title>@ztimson/utils sandbox</title>
|
||||
</head>
|
||||
<body>
|
||||
<script type="module">
|
||||
import {PathEvent} from './dist/index.mjs';
|
||||
|
||||
console.log(PathEvent.filter(['payments/ztimson:cr', 'logs/momentum:c', 'data/Testing:r'], 'data'));
|
||||
console.log(PathEvent.filter(['data/Submissions/Test:r'], 'data/Submissions/Test/test.html'));
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
4978
package-lock.json
generated
4978
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
32
package.json
32
package.json
@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "@ztimson/js-utilities",
|
||||
"version": "0.3.6",
|
||||
"description": "JavaScript Utility library",
|
||||
"name": "@ztimson/utils",
|
||||
"version": "0.23.22",
|
||||
"description": "Utility library",
|
||||
"author": "Zak Timson",
|
||||
"license": "MIT",
|
||||
"private": false,
|
||||
@ -9,30 +9,32 @@
|
||||
"type": "git",
|
||||
"url": "https://git.zakscode.com/ztimson/js-utilities"
|
||||
},
|
||||
"main": "./dist/js-utilities.js",
|
||||
"module": "./dist/js-utilities.mjs",
|
||||
"types": "./dist/src/index.d.ts",
|
||||
"main": "./dist/index.cjs",
|
||||
"module": "./dist/index.mjs",
|
||||
"types": "./dist/index.d.ts",
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./dist/index.d.ts",
|
||||
"import": "./dist/index.mjs",
|
||||
"require": "./dist/index.cjs"
|
||||
}
|
||||
},
|
||||
"scripts": {
|
||||
"build": "npx vite build",
|
||||
"build": "npx tsc && npx vite build",
|
||||
"docs": "typedoc --cleanOutputDir false --out ./docs --entryPoints src/**/*.ts --readme none",
|
||||
"test": "npx jest",
|
||||
"test:coverage": "npx jest --coverage",
|
||||
"watch": "npx vite build --watch"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/jest": "^29.5.12",
|
||||
"@types/node": "^18.14.0",
|
||||
"jest": "^29.7.0",
|
||||
"jest-junit": "^16.0.0",
|
||||
"ts-jest": "^29.1.2",
|
||||
"typedoc": "^0.26.7",
|
||||
"typescript": "^5.3.3",
|
||||
"vite": "^5.0.12",
|
||||
"vite-plugin-dts": "^3.7.2"
|
||||
},
|
||||
"exports": {
|
||||
".": {
|
||||
"import": "./dist/js-utilities.mjs",
|
||||
"require": "./dist/js-utilities.js"
|
||||
}
|
||||
"vite-plugin-dts": "^4.5.3"
|
||||
},
|
||||
"files": [
|
||||
"dist"
|
||||
|
141
src/arg-parser.ts
Normal file
141
src/arg-parser.ts
Normal file
@ -0,0 +1,141 @@
|
||||
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),
|
||||
{name: 'help', desc: 'Display command\'s help message', flags: ['-h', '--help'], default: false}];
|
||||
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 => `${this.name} ${ex}`).join('\n\t');
|
||||
// Arguments
|
||||
if(this.args.length) msg += '\n\n\t' + this.args.map(arg =>
|
||||
`${arg.name.toUpperCase()}${spacer(arg.name)}${arg.desc}`).join('\n\t');
|
||||
// Flags
|
||||
msg += '\n\nOptions:\n\t' + this.flags.map(flag => {
|
||||
const flags = flag.flags?.join(', ') || '';
|
||||
return `${flags}${spacer(flags)}${flag.desc}`;
|
||||
}).join('\n\t');
|
||||
// Commands
|
||||
if(this.commands.length) msg += '\n\nCommands:\n\t' + this.commands.map(command =>
|
||||
`${command.name}${spacer(command.name)}${command.desc}`).join('\n\t');
|
||||
return `${msg}\n\n`;
|
||||
}
|
||||
}
|
55
src/array.ts
55
src/array.ts
@ -1,10 +1,32 @@
|
||||
import {dotNotation, isEqual} from './objects';
|
||||
|
||||
/**
|
||||
* Only add element to array if it isn't already included
|
||||
*
|
||||
* @example
|
||||
* ```js
|
||||
* const arr = addUnique([1, 2, 3], 3);
|
||||
* console.log(arr); // Output: [1, 2, 3]
|
||||
* ```
|
||||
*
|
||||
* @param {T[]} array Target array element will be added to
|
||||
* @param {T} el Unique element to add
|
||||
* @return {T[]} Array with element if it was unique
|
||||
* @deprecated Use ASet to create unique arrays
|
||||
*/
|
||||
export function addUnique<T>(array: T[], el: T): T[] {
|
||||
if(array.indexOf(el) === -1) array.push(el);
|
||||
return array;
|
||||
}
|
||||
|
||||
/**
|
||||
* Find all unique elements in arrays
|
||||
*
|
||||
* @param {any[]} a First array to compare
|
||||
* @param {any[]} b Second array to compare
|
||||
* @return {any[]} Unique elements
|
||||
* @deprecated Use ASet to perform Set operations on arrays
|
||||
*/
|
||||
export function arrayDiff(a: any[], b: any[]): any[] {
|
||||
return makeUnique([
|
||||
...a.filter(v1 => !b.includes((v2: any) => isEqual(v1, v2))),
|
||||
@ -33,6 +55,25 @@ export function caseInsensitiveSort(prop: string) {
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Shorthand to find objects with a property value
|
||||
*
|
||||
* @example
|
||||
* ```js
|
||||
* const found = [
|
||||
* {name: 'Batman'},
|
||||
* {name: 'Superman'},
|
||||
* ].filter(findByProp('name', 'Batman'));
|
||||
* ```
|
||||
*
|
||||
* @param {string} prop Property to compare (Dot nation supported)
|
||||
* @param value Value property must have
|
||||
* @return {(v: any) => boolean} Function used by `filter` or `find`
|
||||
*/
|
||||
export function findByProp(prop: string, value: any) {
|
||||
return (v: any) => isEqual(dotNotation(v, prop), value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively flatten nested arrays
|
||||
*
|
||||
@ -91,10 +132,13 @@ export function sortByProp(prop: string, reverse = false) {
|
||||
};
|
||||
}
|
||||
|
||||
export function findByProp(prop: string, value: any) {
|
||||
return (v: any) => isEqual(v[prop], value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Make sure every element in array is unique
|
||||
*
|
||||
* @param {any[]} arr Array that will be filtered in place
|
||||
* @return {any[]} Original array
|
||||
* @deprecated Please use ASet to create a guaranteed unique array
|
||||
*/
|
||||
export function makeUnique(arr: any[]) {
|
||||
for(let i = arr.length - 1; i >= 0; i--) {
|
||||
if(arr.slice(0, i).find(n => isEqual(n, arr[i]))) arr.splice(i, 1);
|
||||
@ -103,7 +147,8 @@ export function makeUnique(arr: any[]) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Make sure value is an array, if it isn't wrap it in one.
|
||||
* Make sure value is an array, if it isn't wrap it in one
|
||||
*
|
||||
* @param {T[] | T} value Value that should be an array
|
||||
* @returns {T[]} Value in an array
|
||||
*/
|
||||
|
126
src/aset.ts
Normal file
126
src/aset.ts
Normal file
@ -0,0 +1,126 @@
|
||||
import {isEqual} from './objects.ts';
|
||||
|
||||
/**
|
||||
* An array which functions as a set. It guarantees unique elements
|
||||
* and provides set functions for comparisons
|
||||
*/
|
||||
export class ASet<T> extends Array {
|
||||
/** Number of elements in set */
|
||||
get size() {
|
||||
return this.length;
|
||||
}
|
||||
|
||||
/**
|
||||
* Array to create set from, duplicate values will be removed
|
||||
* @param {T[]} elements Elements which will be added to set
|
||||
*/
|
||||
constructor(elements: T[] = []) {
|
||||
super();
|
||||
if(!!elements?.['forEach'])
|
||||
elements.forEach(el => this.add(el));
|
||||
}
|
||||
|
||||
/**
|
||||
* Add elements to set if unique
|
||||
* @param items
|
||||
*/
|
||||
add(...items: T[]) {
|
||||
items.filter(el => !this.has(el)).forEach(el => this.push(el));
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete elements from set
|
||||
* @param items Elements that will be deleted
|
||||
*/
|
||||
delete(...items: T[]) {
|
||||
items.forEach(el => {
|
||||
const index = this.indexOf(el);
|
||||
if(index != -1) this.splice(index, 1);
|
||||
})
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create list of elements this set has which the comparison set does not
|
||||
* @param {ASet<T>} set Set to compare against
|
||||
* @return {ASet<T>} Different elements
|
||||
*/
|
||||
difference(set: ASet<T>) {
|
||||
return new ASet<T>(this.filter(el => !set.has(el)));
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if set includes element
|
||||
* @param {T} el Element to look for
|
||||
* @return {boolean} True if element was found, false otherwise
|
||||
*/
|
||||
has(el: T) {
|
||||
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
|
||||
* @return {boolean} Set of common elements
|
||||
*/
|
||||
intersection(set: ASet<T>) {
|
||||
return new ASet<T>(this.filter(el => set.has(el)));
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if this set has no elements in common with the comparison set
|
||||
* @param {ASet<T>} set Set to compare against
|
||||
* @return {boolean} True if nothing in common, false otherwise
|
||||
*/
|
||||
isDisjointFrom(set: ASet<T>) {
|
||||
return this.intersection(set).size == 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if all elements in this set are included in the comparison set
|
||||
* @param {ASet<T>} set Set to compare against
|
||||
* @return {boolean} True if all elements are included, false otherwise
|
||||
*/
|
||||
isSubsetOf(set: ASet<T>) {
|
||||
return this.findIndex(el => !set.has(el)) == -1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if all elements from comparison set are included in this set
|
||||
* @param {ASet<T>} set Set to compare against
|
||||
* @return {boolean} True if all elements are included, false otherwise
|
||||
*/
|
||||
isSuperset(set: ASet<T>) {
|
||||
return set.findIndex(el => !this.has(el)) == -1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create list of elements that are only in one set but not both (XOR)
|
||||
* @param {ASet<T>} set Set to compare against
|
||||
* @return {ASet<T>} New set of unique elements
|
||||
*/
|
||||
symmetricDifference(set: ASet<T>) {
|
||||
return new ASet([...this.difference(set), ...set.difference(this)]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create joined list of elements included in this & the comparison set
|
||||
* @param {ASet<T>} set Set join
|
||||
* @return {ASet<T>} New set of both previous sets combined
|
||||
*/
|
||||
union(set: ASet<T> | Array<T>) {
|
||||
return new ASet([...this, ...set]);
|
||||
}
|
||||
}
|
170
src/cache.ts
Normal file
170
src/cache.ts
Normal file
@ -0,0 +1,170 @@
|
||||
import {deepCopy} from './objects.ts';
|
||||
|
||||
export type CacheOptions = {
|
||||
/** Delete keys automatically after x amount of seconds */
|
||||
ttl?: number;
|
||||
/** Storage to persist cache */
|
||||
storage?: Storage;
|
||||
/** Key cache will be stored under */
|
||||
storageKey?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Map of data which tracks whether it is a complete collection & offers optional expiry of cached values
|
||||
*/
|
||||
export class Cache<K extends string | number | symbol, T> {
|
||||
private store = <Record<K, T>>{};
|
||||
|
||||
/** Support index lookups */
|
||||
[key: string | number | symbol]: T | any;
|
||||
/** Whether cache is complete */
|
||||
complete = false;
|
||||
|
||||
/**
|
||||
* Create new cache
|
||||
*
|
||||
* @param {keyof T} key Default property to use as primary key
|
||||
* @param options
|
||||
*/
|
||||
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];
|
||||
return deepCopy(target.store[prop as K]);
|
||||
},
|
||||
set: (target: this, prop: string | symbol, value: any) => {
|
||||
if(prop in target) (target as any)[prop] = value;
|
||||
else this.set(prop as K, value);
|
||||
return true;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
private getKey(value: T): K {
|
||||
if(!this.key) throw new Error('No key defined');
|
||||
return <K>value[this.key];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all cached items
|
||||
*
|
||||
* @return {T[]} Array of items
|
||||
*/
|
||||
all(): T[] {
|
||||
return deepCopy(Object.values(this.store));
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a new item to the cache. Like set, but finds key automatically
|
||||
*
|
||||
* @param {T} value Item to add to cache
|
||||
* @param {number | undefined} ttl Override default expiry
|
||||
* @return {this}
|
||||
*/
|
||||
add(value: T, ttl = this.ttl): this {
|
||||
const key = this.getKey(value);
|
||||
this.set(key, value, ttl);
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add several rows to the cache
|
||||
*
|
||||
* @param {T[]} rows Several items that will be cached using the default key
|
||||
* @param complete Mark cache as complete & reliable, defaults to true
|
||||
* @return {this}
|
||||
*/
|
||||
addAll(rows: T[], complete = true): this {
|
||||
rows.forEach(r => this.add(r));
|
||||
this.complete = complete;
|
||||
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 deepCopy(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 deepCopy(this.store);
|
||||
}
|
||||
|
||||
/**
|
||||
* Add an item to the cache manually specifying the key
|
||||
*
|
||||
* @param {K} key Key item will be cached under
|
||||
* @param {T} value Item to cache
|
||||
* @param {number | undefined} ttl Override default expiry in seconds
|
||||
* @return {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 * 1000);
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all cached items
|
||||
*
|
||||
* @return {T[]} Array of items
|
||||
*/
|
||||
values = this.all();
|
||||
}
|
12
src/color.ts
Normal file
12
src/color.ts
Normal file
@ -0,0 +1,12 @@
|
||||
/**
|
||||
* Determine if either black or white provides more contrast to the provided color
|
||||
* @param {string} background Color to compare against
|
||||
* @return {"white" | "black"} Color with the most contrast
|
||||
*/
|
||||
export function blackOrWhite(background: string): 'white' | 'black' {
|
||||
const exploded = background?.match(background.length >= 6 ? /\w\w/g : /\w/g);
|
||||
if(!exploded) return 'black';
|
||||
const [r, g, b] = exploded.map(hex => parseInt(hex, 16));
|
||||
const luminance = (0.299 * r + 0.587 * g + 0.114 * b) / 255;
|
||||
return luminance > 0.5 ? 'black' : 'white';
|
||||
}
|
88
src/csv.ts
Normal file
88
src/csv.ts
Normal file
@ -0,0 +1,88 @@
|
||||
import {makeArray} from './array.ts';
|
||||
import {ASet} from './aset.ts';
|
||||
import {dotNotation, flattenObj, JSONSanitize} from './objects.ts';
|
||||
import {LETTER_LIST} from './string.ts';
|
||||
|
||||
/**
|
||||
* Parse a CSV string into an array of objects
|
||||
*
|
||||
* @param csv String with CSV
|
||||
* @param hasHeaders First line of CSV contains headers
|
||||
* @return {T[]} Array of parsed objects
|
||||
*/
|
||||
export function fromCsv<T = any>(csv: string, hasHeaders = true): T[] {
|
||||
function parseLine(line: string): (string | null)[] {
|
||||
const columns: string[] = [];
|
||||
let current = '', inQuotes = false;
|
||||
for (let i = 0; i < line.length; i++) {
|
||||
const char = line[i];
|
||||
const nextChar = line[i + 1];
|
||||
if (char === '"') {
|
||||
if (inQuotes && nextChar === '"') {
|
||||
current += '"'; // Handle escaped quotes
|
||||
i++;
|
||||
} else inQuotes = !inQuotes;
|
||||
} else if (char === ',' && !inQuotes) {
|
||||
columns.push(current.trim()); // Trim column values
|
||||
current = '';
|
||||
} else current += char;
|
||||
}
|
||||
columns.push(current.trim()); // Trim last column value
|
||||
return columns.map(col => col.replace(/^"|"$/g, '').replace(/""/g, '"'));
|
||||
}
|
||||
|
||||
// Normalize line endings and split rows
|
||||
const rows = [];
|
||||
let currentRow = '', inQuotes = false;
|
||||
for (const char of csv.replace(/\r\n/g, '\n')) { // Normalize \r\n to \n
|
||||
if (char === '"') inQuotes = !inQuotes;
|
||||
if (char === '\n' && !inQuotes) {
|
||||
rows.push(currentRow.trim()); // Trim row
|
||||
currentRow = '';
|
||||
} else currentRow += char;
|
||||
}
|
||||
if (currentRow) rows.push(currentRow.trim()); // Trim last row
|
||||
|
||||
// Extract headers
|
||||
let headers: any = hasHeaders ? rows.splice(0, 1)[0] : null;
|
||||
if (headers) headers = headers.match(/(?:[^,"']+|"(?:[^"]|"")*"|'(?:[^']|'')*')+/g)?.map((h: any) => h.trim());
|
||||
|
||||
// Parse rows
|
||||
return <T[]>rows.map(r => {
|
||||
const props = parseLine(r);
|
||||
const h = headers || (Array(props.length).fill(null).map((_, 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 array of objects to a CSV string
|
||||
*
|
||||
* @param {any[]} target Array of objects to create CSV from
|
||||
* @param {boolean} flatten Should nested object be flattened or treated as values
|
||||
* @return {string} CSV string
|
||||
*/
|
||||
export function toCsv(target: any, flatten=true) {
|
||||
const t = makeArray(target);
|
||||
const headers = new ASet(t.reduce((acc, row) => [...acc, ...Object.keys(flatten ? flattenObj(row) : row)], []));
|
||||
return [
|
||||
headers.join(','),
|
||||
...t.map(row => headers.map((h: string) => {
|
||||
const value = dotNotation<any>(row, h);
|
||||
if(value == null) return '';
|
||||
if(typeof value == 'object') return `"${JSONSanitize(value).replaceAll('"', '""')}"`;
|
||||
if(typeof value == 'string' && /[\n",]/g.test(value)) return `"${value.replaceAll('"', '""')}"`;
|
||||
return value;
|
||||
}).join(','))
|
||||
].join('\n');
|
||||
}
|
@ -1,29 +1,33 @@
|
||||
export type Listener = (...args: any[]) => any;
|
||||
export type TypedEvents = {[k in string | symbol]: Listener} & {'*': (event: string, ...args: any[]) => any};
|
||||
export type TypedListener = (...args: any[]) => any;
|
||||
export type TypedEvents = {[k in string | symbol]: TypedListener} & {'*': (event: string, ...args: any[]) => any};
|
||||
|
||||
export type NamespaceEvents<Namespace extends string, Events extends TypedEvents> = {
|
||||
[K in keyof Events as `${Namespace}:${Extract<K, string>}`]: Events[K];
|
||||
};
|
||||
|
||||
export class TypedEmitter<T extends TypedEvents = TypedEvents> {
|
||||
private static listeners: {[key: string]: Listener[]} = {};
|
||||
private static listeners: {[key: string]: TypedListener[]} = {};
|
||||
|
||||
private listeners: { [key in keyof T]?: Listener[] } = {};
|
||||
private listeners: { [key in keyof T]?: TypedListener[] } = {};
|
||||
|
||||
static emit(event: any, ...args: any[]) {
|
||||
(this.listeners['*'] || []).forEach(l => l(event, ...args));
|
||||
(this.listeners[event.toString()] || []).forEach(l => l(...args));
|
||||
};
|
||||
|
||||
static off(event: any, listener: Listener) {
|
||||
static off(event: any, listener: TypedListener) {
|
||||
const e = event.toString();
|
||||
this.listeners[e] = (this.listeners[e] || []).filter(l => l === listener);
|
||||
}
|
||||
|
||||
static on(event: any, listener: Listener) {
|
||||
static on(event: any, listener: TypedListener) {
|
||||
const e = event.toString();
|
||||
if(!this.listeners[e]) this.listeners[e] = [];
|
||||
this.listeners[e]?.push(listener);
|
||||
return () => this.off(event, listener);
|
||||
}
|
||||
|
||||
static once(event: any, listener?: Listener): Promise<any> {
|
||||
static once(event: any, listener?: TypedListener): Promise<any> {
|
||||
return new Promise(res => {
|
||||
const unsubscribe = this.on(event, <any>((...args: any) => {
|
||||
res(args.length == 1 ? args[0] : args);
|
||||
|
133
src/errors.ts
133
src/errors.ts
@ -1,15 +1,3 @@
|
||||
import {XHR} from './xhr';
|
||||
|
||||
XHR.addInterceptor((resp: Response, next: () => {}) => {
|
||||
if(resp.status == 200) return next();
|
||||
if(resp.status == 400) throw new BadRequestError(resp.statusText);
|
||||
if(resp.status == 401) throw new UnauthorizedError(resp.statusText);
|
||||
if(resp.status == 403) throw new ForbiddenError(resp.statusText);
|
||||
if(resp.status == 404) throw new NotFoundError(resp.statusText);
|
||||
if(resp.status == 500) throw new InternalServerError(resp.statusText);
|
||||
throw new CustomError(resp.statusText, resp.status);
|
||||
});
|
||||
|
||||
export class CustomError extends Error {
|
||||
static code = 500;
|
||||
|
||||
@ -65,6 +53,18 @@ export class UnauthorizedError extends CustomError {
|
||||
}
|
||||
}
|
||||
|
||||
export class PaymentRequiredError extends CustomError {
|
||||
static code = 402;
|
||||
|
||||
constructor(message: string = 'Payment Required') {
|
||||
super(message);
|
||||
}
|
||||
|
||||
static instanceof(err: Error) {
|
||||
return (<any>err).constructor.code == this.code;
|
||||
}
|
||||
}
|
||||
|
||||
export class ForbiddenError extends CustomError {
|
||||
static code = 403;
|
||||
|
||||
@ -89,6 +89,30 @@ export class NotFoundError extends CustomError {
|
||||
}
|
||||
}
|
||||
|
||||
export class MethodNotAllowedError extends CustomError {
|
||||
static code = 405;
|
||||
|
||||
constructor(message: string = 'Method Not Allowed') {
|
||||
super(message);
|
||||
}
|
||||
|
||||
static instanceof(err: Error) {
|
||||
return (<any>err).constructor.code == this.code;
|
||||
}
|
||||
}
|
||||
|
||||
export class NotAcceptableError extends CustomError {
|
||||
static code = 406;
|
||||
|
||||
constructor(message: string = 'Not Acceptable') {
|
||||
super(message);
|
||||
}
|
||||
|
||||
static instanceof(err: Error) {
|
||||
return (<any>err).constructor.code == this.code;
|
||||
}
|
||||
}
|
||||
|
||||
export class InternalServerError extends CustomError {
|
||||
static code = 500;
|
||||
|
||||
@ -100,3 +124,88 @@ export class InternalServerError extends CustomError {
|
||||
return (<any>err).constructor.code == this.code;
|
||||
}
|
||||
}
|
||||
|
||||
export class NotImplementedError extends CustomError {
|
||||
static code = 501;
|
||||
|
||||
constructor(message: string = 'Not Implemented') {
|
||||
super(message);
|
||||
}
|
||||
|
||||
static instanceof(err: Error) {
|
||||
return (<any>err).constructor.code == this.code;
|
||||
}
|
||||
}
|
||||
|
||||
export class BadGatewayError extends CustomError {
|
||||
static code = 502;
|
||||
|
||||
constructor(message: string = 'Bad Gateway') {
|
||||
super(message);
|
||||
}
|
||||
|
||||
static instanceof(err: Error) {
|
||||
return (<any>err).constructor.code == this.code;
|
||||
}
|
||||
}
|
||||
|
||||
export class ServiceUnavailableError extends CustomError {
|
||||
static code = 503;
|
||||
|
||||
constructor(message: string = 'Service Unavailable') {
|
||||
super(message);
|
||||
}
|
||||
|
||||
static instanceof(err: Error) {
|
||||
return (<any>err).constructor.code == this.code;
|
||||
}
|
||||
}
|
||||
|
||||
export class GatewayTimeoutError extends CustomError {
|
||||
static code = 504;
|
||||
|
||||
constructor(message: string = 'Gateway Timeout') {
|
||||
super(message);
|
||||
}
|
||||
|
||||
static instanceof(err: Error) {
|
||||
return (<any>err).constructor.code == this.code;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create the correct error object from a status code
|
||||
* @param {number} code Will be converted to respective error (ex. 404 -> NotFoundError)
|
||||
* @param {string} message Override default error message
|
||||
* @return {CustomError} The proper error type
|
||||
*/
|
||||
export function errorFromCode(code: number, message?: string) {
|
||||
switch(code) {
|
||||
case 400:
|
||||
return new BadRequestError(message);
|
||||
case 401:
|
||||
return new UnauthorizedError(message);
|
||||
case 402:
|
||||
return new PaymentRequiredError(message);
|
||||
case 403:
|
||||
return new ForbiddenError(message);
|
||||
case 404:
|
||||
return new NotFoundError(message);
|
||||
case 405:
|
||||
return new MethodNotAllowedError(message);
|
||||
case 406:
|
||||
return new NotAcceptableError(message);
|
||||
case 500:
|
||||
return new InternalServerError(message);
|
||||
case 501:
|
||||
return new NotImplementedError(message);
|
||||
case 502:
|
||||
return new BadGatewayError(message);
|
||||
case 503:
|
||||
return new ServiceUnavailableError(message);
|
||||
case 504:
|
||||
return new GatewayTimeoutError(message);
|
||||
default:
|
||||
return new CustomError(message, code);
|
||||
}
|
||||
}
|
||||
|
111
src/files.ts
Normal file
111
src/files.ts
Normal file
@ -0,0 +1,111 @@
|
||||
import {makeArray} from './array.ts';
|
||||
import {JSONAttemptParse} from './objects.ts';
|
||||
import {PromiseProgress} from './promise-progress';
|
||||
import {formatDate} from './time.ts';
|
||||
|
||||
/**
|
||||
* Download blob as a file
|
||||
*
|
||||
* @param {Blob} blob File as a blob
|
||||
* @param {string} name Name blob will be downloaded as
|
||||
*/
|
||||
export function downloadFile(blob: Blob | string | string[], name: string) {
|
||||
if(!(blob instanceof Blob)) blob = new Blob(makeArray(blob));
|
||||
const url = URL.createObjectURL(blob);
|
||||
downloadUrl(url, name);
|
||||
URL.revokeObjectURL(url);
|
||||
}
|
||||
|
||||
/**
|
||||
* Download a file from a URL
|
||||
*
|
||||
* @param href URL that will be downloaded
|
||||
* @param {string} name Override download name
|
||||
*/
|
||||
export function downloadUrl(href: any, name?: string) {
|
||||
const a = document.createElement('a');
|
||||
a.href = href;
|
||||
a.download = name || href.split('/').pop();
|
||||
document.body.appendChild(a);
|
||||
a.click();
|
||||
document.body.removeChild(a);
|
||||
}
|
||||
|
||||
/**
|
||||
* Open filebrowser & return selected file
|
||||
*
|
||||
* @param {{accept?: string, multiple?: boolean}} options accept - selectable mimetypes, multiple - Allow selecting more than 1 file
|
||||
* @return {Promise<File[]>} Array of selected files
|
||||
*/
|
||||
export function fileBrowser(options: {accept?: string, multiple?: boolean} = {}): Promise<File[]> {
|
||||
return new Promise(res => {
|
||||
const input = document.createElement('input');
|
||||
input.type = 'file';
|
||||
input.accept = options.accept || '*';
|
||||
input.style.display='none';
|
||||
input.multiple = !!options.multiple;
|
||||
input.onblur = input.onchange = async () => {
|
||||
res(Array.from(<any>input.files));
|
||||
input.remove();
|
||||
}
|
||||
document.body.appendChild(input);
|
||||
input.click();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
*
|
||||
* @param {string} name Name of file, `{{TIMESTAMP}}` will be replaced
|
||||
* @param {Date | number | string} date Date to use for timestamp
|
||||
* @return {string} Interpolated filename, or the raw timestamp if name was omitted
|
||||
*/
|
||||
export function timestampFilename(name?: string, date: Date | number | string = new Date()) {
|
||||
if(typeof date == 'number' || typeof date == 'string') date = new Date(date);
|
||||
const timestamp = formatDate('YYYY-MM-DD_HH:mm:ss', date);
|
||||
return name ? name.replace('{{TIMESTAMP}}', timestamp) : timestamp;
|
||||
}
|
||||
|
||||
/**
|
||||
* Upload file to URL with progress callback using PromiseProgress
|
||||
*
|
||||
* @param {{url: string, files: File[], headers?: {[p: string]: string}, withCredentials?: boolean}} options
|
||||
* @return {PromiseProgress<T>} Promise of request with `onProgress` callback
|
||||
*/
|
||||
export function uploadWithProgress<T>(options: {
|
||||
url: string;
|
||||
files: File[];
|
||||
headers?: {[key: string]: string};
|
||||
withCredentials?: boolean;
|
||||
}): PromiseProgress<T> {
|
||||
return new PromiseProgress<T>((res, rej, prog) => {
|
||||
const xhr = new XMLHttpRequest();
|
||||
const formData = new FormData();
|
||||
options.files.forEach(f => formData.append('file', f));
|
||||
|
||||
xhr.withCredentials = !!options.withCredentials;
|
||||
xhr.upload.addEventListener('progress', (event) => event.lengthComputable ? prog(event.loaded / event.total) : null);
|
||||
xhr.addEventListener('loadend', () => res(<T>JSONAttemptParse(xhr.responseText)));
|
||||
xhr.addEventListener('error', () => rej(JSONAttemptParse(xhr.responseText)));
|
||||
xhr.addEventListener('timeout', () => rej({error: 'Request timed out'}));
|
||||
|
||||
xhr.open('POST', options.url);
|
||||
Object.entries(options.headers || {}).forEach(([key, value]) => xhr.setRequestHeader(key, value));
|
||||
xhr.send(formData);
|
||||
});
|
||||
}
|
148
src/http.ts
Normal file
148
src/http.ts
Normal file
@ -0,0 +1,148 @@
|
||||
import {clean} from './objects';
|
||||
import {PromiseProgress} from './promise-progress';
|
||||
|
||||
export type DecodedResponse<T> = Response & {data: T | null}
|
||||
|
||||
export type HttpInterceptor = (response: Response, next: () => void) => void;
|
||||
|
||||
export type HttpRequestOptions = {
|
||||
body?: any;
|
||||
decode?: boolean;
|
||||
fragment?: string;
|
||||
headers?: {[key: string | symbol]: string | null | undefined};
|
||||
method?: 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
|
||||
query?: {key: string, value: string}[] | {[key: string]: string};
|
||||
url?: string;
|
||||
[key: string]: any;
|
||||
}
|
||||
|
||||
export type HttpDefaults = {
|
||||
headers?: {[key: string | symbol]: string | null | undefined};
|
||||
interceptors?: HttpInterceptor[];
|
||||
url?: string;
|
||||
}
|
||||
|
||||
class HttpResponse<T = any> extends Response {
|
||||
data?: T
|
||||
ok!: boolean;
|
||||
redirected!: boolean;
|
||||
type!: ResponseType;
|
||||
url!: string;
|
||||
|
||||
constructor(resp: Response, stream: ReadableStream) {
|
||||
const body = [204, 205, 304].includes(resp.status) ? null : stream;
|
||||
super(body, {
|
||||
headers: resp.headers,
|
||||
status: resp.status,
|
||||
statusText: resp.statusText,
|
||||
});
|
||||
|
||||
this.ok = resp.ok;
|
||||
this.redirected = resp.redirected;
|
||||
this.type = resp.type;
|
||||
this.url = resp.url;
|
||||
}
|
||||
}
|
||||
|
||||
export class Http {
|
||||
private static interceptors: {[key: string]: HttpInterceptor} = {};
|
||||
|
||||
static headers: {[key: string]: string | null | undefined} = {};
|
||||
|
||||
private interceptors: {[key: string]: HttpInterceptor} = {}
|
||||
|
||||
headers: {[key: string]: string | null | undefined} = {}
|
||||
url!: string | null;
|
||||
|
||||
constructor(defaults: HttpDefaults = {}) {
|
||||
this.url = defaults.url ?? null;
|
||||
this.headers = defaults.headers || {};
|
||||
if(defaults.interceptors) {
|
||||
defaults.interceptors.forEach(i => Http.addInterceptor(i));
|
||||
}
|
||||
}
|
||||
|
||||
static addInterceptor(fn: HttpInterceptor): () => void {
|
||||
const key = Object.keys(Http.interceptors).length.toString();
|
||||
Http.interceptors[key] = fn;
|
||||
return () => { Http.interceptors[key] = <any>null; }
|
||||
}
|
||||
|
||||
addInterceptor(fn: HttpInterceptor): () => void {
|
||||
const key = Object.keys(this.interceptors).length.toString();
|
||||
this.interceptors[key] = fn;
|
||||
return () => { this.interceptors[key] = <any>null; }
|
||||
}
|
||||
|
||||
request<T>(opts: HttpRequestOptions = {}): PromiseProgress<DecodedResponse<T>> {
|
||||
if(!this.url && !opts.url) throw new Error('URL needs to be set');
|
||||
let url = opts.url?.startsWith('http') ? opts.url : (this.url || '') + (opts.url || '');
|
||||
url = url.replaceAll(/([^:]\/)\/+/g, '$1');
|
||||
if(opts.fragment) url.includes('#') ? url.replace(/#.*(\?|\n)/g, (match, arg1) => `#${opts.fragment}${arg1}`) : `${url}#${opts.fragment}`;
|
||||
if(opts.query) {
|
||||
const q = Array.isArray(opts.query) ? opts.query :
|
||||
Object.keys(opts.query).map(k => ({key: k, value: (<any>opts.query)[k]}))
|
||||
url += (url.includes('?') ? '&' : '?') + q.map(q => `${q.key}=${q.value}`).join('&');
|
||||
}
|
||||
|
||||
// Prep headers
|
||||
const headers = <any>clean({
|
||||
'Content-Type': !opts.body ? undefined : (opts.body instanceof FormData ? 'multipart/form-data' : 'application/json'),
|
||||
...Http.headers,
|
||||
...this.headers,
|
||||
...opts.headers
|
||||
});
|
||||
|
||||
if(typeof opts.body == 'object' && opts.body != null && headers['Content-Type'] == 'application/json')
|
||||
opts.body = JSON.stringify(opts.body);
|
||||
|
||||
// Send request
|
||||
return new PromiseProgress((res, rej, prog) => {
|
||||
try {
|
||||
fetch(url, {
|
||||
headers,
|
||||
method: opts.method || (opts.body ? 'POST' : 'GET'),
|
||||
body: opts.body
|
||||
}).then(async (resp: any) => {
|
||||
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 = new HttpResponse<T>(resp, stream);
|
||||
if(opts.decode !== false) {
|
||||
const content = resp.headers.get('Content-Type')?.toLowerCase();
|
||||
if(content?.includes('form')) resp.data = <T>await resp.formData();
|
||||
else if(content?.includes('json')) resp.data = <T>await resp.json();
|
||||
else if(content?.includes('text')) resp.data = <T>await resp.text();
|
||||
else if(content?.includes('application')) resp.data = <T>await resp.blob();
|
||||
}
|
||||
|
||||
if(resp.ok) res(resp);
|
||||
else rej(resp);
|
||||
}).catch(err => rej(err));
|
||||
} catch(err) {
|
||||
rej(err);
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
14
src/index.ts
14
src/index.ts
@ -1,9 +1,21 @@
|
||||
export * from './arg-parser';
|
||||
export * from './array';
|
||||
export * from './aset';
|
||||
export * from './cache';
|
||||
export * from './color';
|
||||
export * from './csv';
|
||||
export * from './files';
|
||||
export * from './emitter';
|
||||
export * from './errors';
|
||||
export * from './http';
|
||||
export * from './jwt';
|
||||
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 './xhr';
|
||||
export * from './types';
|
||||
|
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 {JSONSanitize} from './objects.ts';
|
||||
|
||||
export const CliEffects = {
|
||||
CLEAR: "\x1b[0m",
|
||||
@ -42,72 +43,64 @@ export const CliBackground = {
|
||||
}
|
||||
|
||||
export enum LOG_LEVEL {
|
||||
VERBOSE,
|
||||
DEBUG = 0,
|
||||
LOG = 1,
|
||||
ERROR = 0,
|
||||
WARN = 1,
|
||||
INFO = 2,
|
||||
WARN = 3,
|
||||
ERROR = 4,
|
||||
LOG = 3,
|
||||
DEBUG = 4,
|
||||
}
|
||||
|
||||
export type LoggerEvents = TypedEvents & {
|
||||
'VERBOSE': (...args: any[]) => any;
|
||||
'INFO': (...args: any[]) => any;
|
||||
'WARN': (...args: any[]) => any;
|
||||
'ERROR': (...args: any[]) => any;
|
||||
'WARN': (...args: any[]) => any;
|
||||
'INFO': (...args: any[]) => any;
|
||||
'LOG': (...args: any[]) => any;
|
||||
'DEBUG': (...args: any[]) => any;
|
||||
};
|
||||
|
||||
export class Logger extends TypedEmitter<LoggerEvents> {
|
||||
static LOG_LEVEL: LOG_LEVEL = LOG_LEVEL.VERBOSE;
|
||||
static LOG_LEVEL: LOG_LEVEL = LOG_LEVEL.DEBUG;
|
||||
|
||||
constructor(public readonly namespace?: string) {
|
||||
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[]) {
|
||||
if(Logger.LOG_LEVEL > LOG_LEVEL.VERBOSE) return;
|
||||
debug(...args: any[]) {
|
||||
if(Logger.LOG_LEVEL < LOG_LEVEL.DEBUG) return;
|
||||
const str = this.format(...args);
|
||||
Logger.emit(LOG_LEVEL.VERBOSE, str);
|
||||
Logger.emit(LOG_LEVEL.DEBUG, str);
|
||||
console.debug(CliForeground.LIGHT_GREY + str + CliEffects.CLEAR);
|
||||
}
|
||||
|
||||
log(...args: string[]) {
|
||||
if(Logger.LOG_LEVEL > LOG_LEVEL.INFO) return;
|
||||
log(...args: any[]) {
|
||||
if(Logger.LOG_LEVEL < LOG_LEVEL.LOG) return;
|
||||
const str = this.format(...args);
|
||||
Logger.emit(LOG_LEVEL.INFO, str);
|
||||
Logger.emit(LOG_LEVEL.LOG, str);
|
||||
console.log(CliEffects.CLEAR + str);
|
||||
}
|
||||
|
||||
info(...args: string[]) {
|
||||
if(Logger.LOG_LEVEL > LOG_LEVEL.INFO) return;
|
||||
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[]) {
|
||||
if(Logger.LOG_LEVEL > LOG_LEVEL.WARN) return;
|
||||
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[]) {
|
||||
if(Logger.LOG_LEVEL > LOG_LEVEL.ERROR) return;
|
||||
error(...args: any[]) {
|
||||
if(Logger.LOG_LEVEL < LOG_LEVEL.ERROR) return;
|
||||
const str = this.format(...args);
|
||||
Logger.emit(LOG_LEVEL.ERROR, str);
|
||||
console.error(CliForeground.RED + str + CliEffects.CLEAR);
|
||||
|
45
src/math.ts
Normal file
45
src/math.ts
Normal file
@ -0,0 +1,45 @@
|
||||
/**
|
||||
* Convert decimal number to fraction
|
||||
*
|
||||
* @example
|
||||
* ```js
|
||||
* dec2Frac(1.25) // Outputs: "1 1/4"
|
||||
* ```
|
||||
*
|
||||
* @param {number} num Number to convert
|
||||
* @return {string} Fraction with remainder
|
||||
*/
|
||||
export function dec2Frac(num: number) {
|
||||
const gcd = (a: number, b: number): number => {
|
||||
if (b < 0.0000001) return a;
|
||||
return gcd(b, ~~(a % b));
|
||||
};
|
||||
|
||||
const len = num.toString().length - 2;
|
||||
let denominator = Math.pow(10, len);
|
||||
let numerator = num * denominator;
|
||||
const divisor = gcd(numerator, denominator);
|
||||
numerator = ~~(numerator / divisor);
|
||||
denominator = ~~(denominator / divisor)
|
||||
const remainder = ~~(numerator / denominator);
|
||||
numerator -= remainder * denominator;
|
||||
return `${remainder ? remainder + ' ' : ''}${~~(numerator)}/${~~(denominator)}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert fraction to decimal number
|
||||
*
|
||||
* @example
|
||||
* ```js
|
||||
* fracToDec('1 1/4') // Outputs: 1.25
|
||||
* ```
|
||||
*
|
||||
* @param {string} frac Fraction to convert
|
||||
* @return {number} Faction as a decimal
|
||||
*/
|
||||
export function fracToDec(frac: string) {
|
||||
let split = frac.split(' ');
|
||||
const whole = split.length == 2 ? Number(split[0]) : 0;
|
||||
split = (<string>split.pop()).split('/');
|
||||
return whole + (Number(split[0]) / Number(split[1]));
|
||||
}
|
60
src/misc.ts
60
src/misc.ts
@ -1,63 +1,27 @@
|
||||
import {PathEvent} from './path-events.ts';
|
||||
import {md5} from './string';
|
||||
|
||||
/**
|
||||
* Convert data into a form encoded format.
|
||||
*
|
||||
* @param {any} data - data to convert
|
||||
* @returns {string} - Ecodeded form data
|
||||
*/
|
||||
export function formEncode(data: any): string {
|
||||
return Object.entries(data).map(([key, value]) =>
|
||||
encodeURIComponent(key) + '=' + encodeURIComponent(<any>value)
|
||||
).join('&');
|
||||
}
|
||||
|
||||
/**
|
||||
* Get profile image from Gravatar
|
||||
*
|
||||
* @param {string} email Account email address
|
||||
* @param {string} def Default image, can be a link or '404', see: https://docs.gravatar.com/general/images/
|
||||
* @returns {string} Gravatar URL
|
||||
*/
|
||||
export function gravatar(email: string) {
|
||||
export function gravatar(email: string, def='mp') {
|
||||
if(!email) return '';
|
||||
return `https://www.gravatar.com/avatar/${md5(email)}`;
|
||||
}
|
||||
|
||||
/** Parts of a URL */
|
||||
export type ParsedUrl = {
|
||||
protocol?: string,
|
||||
subdomain?: string,
|
||||
domain: string,
|
||||
host: string,
|
||||
port?: number,
|
||||
path?: string,
|
||||
query?: {[name: string]: string}
|
||||
fragment?: string
|
||||
return `https://www.gravatar.com/avatar/${md5(email)}?d=${def}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Escape any regex special characters to avoid misinterpretation during search
|
||||
*
|
||||
* @param {string} url
|
||||
* @returns {RegExpExecArray}
|
||||
* @param {string} value String which should be escaped
|
||||
* @return {string} New escaped sequence
|
||||
*/
|
||||
export function urlParser(url: string): ParsedUrl {
|
||||
const processed = new RegExp(
|
||||
'(?:(?<protocol>[\\w\\d]+)\\:\\/\\/)?(?:(?<user>.+)\\@)?(?<host>(?<domain>[^:\\/\\?#@\\n]+)(?:\\:(?<port>\\d*))?)(?<path>\\/.*?)?(?:\\?(?<query>.*?))?(?:#(?<fragment>.*?))?$',
|
||||
'gm').exec(url);
|
||||
const groups: ParsedUrl = <any>processed?.groups ?? {};
|
||||
const domains = groups.domain.split('.');
|
||||
if(groups['port'] != null) groups.port = Number(groups.port);
|
||||
if(domains.length > 2) {
|
||||
groups.domain = domains.splice(-2, 2).join('.');
|
||||
groups.subdomain = domains.join('.');
|
||||
}
|
||||
if(groups.query) {
|
||||
const split = (<any>groups.query).split('&'), query: any = {};
|
||||
split.forEach((q: any) => {
|
||||
const [key, val] = q.split('=');
|
||||
query[key] = val;
|
||||
});
|
||||
groups.query = query;
|
||||
}
|
||||
return groups;
|
||||
export function escapeRegex(value: string) {
|
||||
return value.replace(/[.*+?^${}()|\[\]\\]/g, '\\$&');
|
||||
}
|
||||
|
||||
export type Listener = (event: PathEvent, ...args: any[]) => any;
|
||||
export type Unsubscribe = () => void;
|
||||
|
122
src/objects.ts
122
src/objects.ts
@ -27,12 +27,33 @@ export function clean<T>(obj: T, undefinedOnly = false): Partial<T> {
|
||||
* Create a deep copy of an object (vs. a shallow copy of references)
|
||||
*
|
||||
* Should be replaced by `structuredClone` once released.
|
||||
*
|
||||
* @param {T} value Object to copy
|
||||
* @returns {T} Type
|
||||
*/
|
||||
export function deepCopy<T>(value: T): T {
|
||||
return JSON.parse(JSON.stringify(value));
|
||||
try {return structuredClone(value); }
|
||||
catch { return JSON.parse(JSONSanitize(value)); }
|
||||
}
|
||||
|
||||
/**
|
||||
* Merge any number of objects into the target
|
||||
*
|
||||
* @param target Destination of all properties
|
||||
* @param sources Objects that will copied into target
|
||||
* @return {any} The des
|
||||
*/
|
||||
export function deepMerge<T>(target: any, ...sources: any[]): T {
|
||||
sources.forEach(s => {
|
||||
for(const key in s) {
|
||||
if(s[key] && typeof s[key] == 'object' && !Array.isArray(s[key])) {
|
||||
if(!target[key]) target[key] = {};
|
||||
deepMerge(target[key], s[key]);
|
||||
} else {
|
||||
target[key] = s[key];
|
||||
}
|
||||
}
|
||||
});
|
||||
return target;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -71,7 +92,26 @@ export function dotNotation<T>(obj: any, prop: string, set?: T): T | undefined {
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively flatten a nested object, while maintaining key structure.
|
||||
* Convert object into URL encoded query string
|
||||
*
|
||||
* @example
|
||||
* ```js
|
||||
* const query = encodeQuery({page: 1, size: 20});
|
||||
* console.log(query); // Output: "page=1&size=20"
|
||||
* ```
|
||||
*
|
||||
* @param {any} data - data to convert
|
||||
* @returns {string} - Encoded form data
|
||||
*/
|
||||
export function encodeQuery(data: any): string {
|
||||
return Object.entries(data).map(([key, value]) =>
|
||||
encodeURIComponent(key) + '=' + encodeURIComponent(<any>value)
|
||||
).join('&');
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Recursively flatten a nested object, while maintaining key structure
|
||||
*
|
||||
* @example
|
||||
* ```ts
|
||||
@ -87,8 +127,9 @@ export function dotNotation<T>(obj: any, prop: string, set?: T): T | undefined {
|
||||
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];
|
||||
@ -98,6 +139,18 @@ export function flattenObj(obj: any, parent?: any, result: any = {}) {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert object to FormData
|
||||
*
|
||||
* @param target - Object to convert
|
||||
* @return {FormData} - Form object
|
||||
*/
|
||||
export function formData(target: any): FormData {
|
||||
const data = new FormData();
|
||||
Object.entries(target).forEach(([key, value]) => data.append(key, <any>value));
|
||||
return data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check that an object has the following values
|
||||
*
|
||||
@ -115,7 +168,7 @@ export function flattenObj(obj: any, parent?: any, result: any = {}) {
|
||||
*/
|
||||
export function includes(target: any, values: any, allowMissing = false): boolean {
|
||||
if(target == undefined) return allowMissing;
|
||||
if(Array.isArray(values)) return values.findIndex((e, i) => !includes(target[i], values[i], allowMissing)) == -1;
|
||||
if(Array.isArray(values)) return values.findIndex((e: any, i: number) => !includes(target[i], values[i], allowMissing)) == -1;
|
||||
const type = typeof values;
|
||||
if(type != typeof target) return false;
|
||||
if(type == 'object') {
|
||||
@ -140,3 +193,60 @@ export function isEqual(a: any, b: any): boolean {
|
||||
if(keys.length != Object.keys(b).length) return false;
|
||||
return Object.keys(a).every(key => isEqual(a[key], b[key]));
|
||||
}
|
||||
|
||||
/**
|
||||
* Experimental: Combine multiple object prototypes into one
|
||||
*
|
||||
* @param target Object that will have prototypes added
|
||||
* @param {any[]} constructors Additionally prototypes that should be merged into target
|
||||
*/
|
||||
export function mixin(target: any, constructors: any[]) {
|
||||
constructors.forEach(c => {
|
||||
Object.getOwnPropertyNames(c.prototype).forEach((name) => {
|
||||
Object.defineProperty(
|
||||
target.prototype,
|
||||
name,
|
||||
Object.getOwnPropertyDescriptor(c.prototype, name) ||
|
||||
Object.create(null)
|
||||
);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse JSON but return the original string if it fails
|
||||
*
|
||||
* @param {any} json JSON string to parse
|
||||
* @return {string | T} Object if successful, original string otherwise
|
||||
*/
|
||||
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.
|
||||
*
|
||||
* @param obj Object to convert to JSON
|
||||
* @param {number} space Format the JSON with spaces
|
||||
* @return {string} JSON 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)) cache.push(value);
|
||||
return value;
|
||||
}, space);
|
||||
}
|
||||
|
280
src/path-events.ts
Normal file
280
src/path-events.ts
Normal file
@ -0,0 +1,280 @@
|
||||
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.fullPath.startsWith(t.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));
|
||||
}
|
||||
}
|
72
src/promise-progress.ts
Normal file
72
src/promise-progress.ts
Normal file
@ -0,0 +1,72 @@
|
||||
export type ProgressCallback = (progress: number) => any;
|
||||
|
||||
/**
|
||||
* A promise that fires the `onProgress` callback on incremental progress
|
||||
*
|
||||
* @example
|
||||
* ```js
|
||||
* const promise = new Promise((resolve, reject, progress) => {
|
||||
* const max = 10;
|
||||
* for(let i = 0; i < max; i++) progress(i / max);
|
||||
* resolve(1);
|
||||
* });
|
||||
*
|
||||
* console.log(promise.progress);
|
||||
*
|
||||
* promise.onProgress(console.log)
|
||||
* .then(console.log)
|
||||
* .catch(console.error)
|
||||
* .finally(...);
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
export class PromiseProgress<T> extends Promise<T> {
|
||||
private listeners: ProgressCallback[] = [];
|
||||
|
||||
private _progress = 0;
|
||||
get progress() { return this._progress; }
|
||||
set progress(p: number) {
|
||||
if(p == this._progress) return;
|
||||
this._progress = p;
|
||||
this.listeners.forEach(l => l(p));
|
||||
}
|
||||
|
||||
constructor(executor: (resolve: (value: T) => any, reject: (reason: any) => void, progress: (progress: number) => any) => void) {
|
||||
super((resolve, reject) => executor(
|
||||
(value: T) => resolve(value),
|
||||
(reason: any) => reject(reason),
|
||||
(progress: number) => this.progress = progress,
|
||||
));
|
||||
}
|
||||
|
||||
static from<T>(promise: Promise<T>): PromiseProgress<T> {
|
||||
if(promise instanceof PromiseProgress) return promise;
|
||||
return new PromiseProgress<T>((res, rej) => promise
|
||||
.then((...args) => res(...args))
|
||||
.catch((...args) => rej(...args)));
|
||||
}
|
||||
|
||||
private from(promise: Promise<T>): PromiseProgress<T> {
|
||||
const newPromise = PromiseProgress.from(promise);
|
||||
this.onProgress(p => newPromise.progress = p);
|
||||
return newPromise;
|
||||
}
|
||||
|
||||
onProgress(callback: ProgressCallback) {
|
||||
this.listeners.push(callback);
|
||||
return this;
|
||||
}
|
||||
|
||||
then(res?: (v: T) => any, rej?: (err: any) => any): PromiseProgress<any> {
|
||||
const resp = super.then(res, rej);
|
||||
return this.from(resp);
|
||||
}
|
||||
|
||||
catch(rej?: (err: any) => any): PromiseProgress<any> {
|
||||
return this.from(super.catch(rej));
|
||||
}
|
||||
|
||||
finally(res?: () => any): PromiseProgress<any> {
|
||||
return this.from(super.finally(res));
|
||||
}
|
||||
}
|
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;
|
||||
})
|
||||
});
|
||||
}
|
180
src/string.ts
180
src/string.ts
@ -1,44 +1,63 @@
|
||||
export function countChars(text: string, pattern: RegExp) {
|
||||
return text.length - text.replaceAll(pattern, '').length;
|
||||
}
|
||||
|
||||
export function createHex(length: number) {
|
||||
return Array(length).fill(null).map(() => Math.round(Math.random() * 0xF).toString(16)).join('');
|
||||
}
|
||||
|
||||
/**
|
||||
* 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;
|
||||
|
||||
/**
|
||||
* Converts text to camelCase
|
||||
*/
|
||||
export function camelCase(str?: string) {
|
||||
const text = pascalCase(str);
|
||||
return text[0].toLowerCase() + text.slice(1);
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert number of bytes into a human-readable size
|
||||
*
|
||||
* @param {number} bytes Number of bytes
|
||||
* @param {number} decimals Decimal places to preserve
|
||||
* @return {string} Formated size
|
||||
*/
|
||||
export function formatBytes(bytes: number, decimals = 2) {
|
||||
if (bytes === 0) return '0 Bytes';
|
||||
const k = 1024;
|
||||
const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
|
||||
const i = Math.floor(Math.log(bytes) / Math.log(k));
|
||||
return parseFloat((bytes / Math.pow(k, i)).toFixed(decimals)) + ' ' + sizes[i];
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract numbers from a string & create a formated phone number: +1 (123) 456-7890
|
||||
*
|
||||
* @param {string} number String that will be parsed for numbers
|
||||
* @return {string} Formated phone number
|
||||
*/
|
||||
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();
|
||||
}
|
||||
|
||||
/**
|
||||
* Insert a string into another string at a given position
|
||||
*
|
||||
* @example
|
||||
* ```
|
||||
* ```js
|
||||
* console.log(insertAt('Hello world!', ' glorious', 5);
|
||||
* // Output: Hello glorious world!
|
||||
* ```
|
||||
@ -47,17 +66,65 @@ 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)}`;
|
||||
}
|
||||
|
||||
export function pad(text: any, length: number, char: string, start = true) {
|
||||
const t = text.toString();
|
||||
const l = length - t.length;
|
||||
if(l <= 0) return t;
|
||||
const padding = Array(~~(l / char.length)).fill(char).join('');
|
||||
return start ? padding + t : t + padding;
|
||||
/**
|
||||
* Converts text to kebab-case
|
||||
*/
|
||||
export function kebabCase(str: string) {
|
||||
if(!str) return '';
|
||||
return str.replaceAll(/(^[^a-zA-Z]+|[^a-zA-Z0-9-_])/g, '')
|
||||
.replaceAll(/([A-Z]|[0-9]+)/g, (...args) => `-${args[0].toLowerCase()}`)
|
||||
.replaceAll(/([0-9])([a-z])/g, (...args) => `${args[1]}-${args[2]}`)
|
||||
.replaceAll(/[^a-z0-9]+(\w?)/g, (...args) => `-${args[1] ?? ''}`).toLowerCase();
|
||||
}
|
||||
|
||||
/**
|
||||
* Add padding to string
|
||||
*
|
||||
* @example
|
||||
* ```js
|
||||
* const now = new Date();
|
||||
* const padded = now.getHours() + ':' + pad(now.getMinutes(), 2, '0');
|
||||
* console.log(padded); // Output: "2:05"
|
||||
* ```
|
||||
*
|
||||
* @param text Text that will be padded
|
||||
* @param {number} length Target length
|
||||
* @param {string} char Character to use as padding, defaults to space
|
||||
* @param {boolean} start Will pad start of text if true, or the end if false
|
||||
* @return {string} Padded string
|
||||
* @deprecated Please use `String.padStart` & `String.padEnd`
|
||||
*/
|
||||
export function pad(text: any, length: number, char: string = ' ', start = true) {
|
||||
if(start) return text.toString().padStart(length, char);
|
||||
return text.toString().padEnd(length, char);
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert text to PascalCase
|
||||
* @param {string} str
|
||||
* @return {string}
|
||||
*/
|
||||
export function pascalCase(str?: string) {
|
||||
if(!str) return '';
|
||||
const text = str.replaceAll(/(^[^a-zA-Z]+|[^a-zA-Z0-9-_])/g, '')
|
||||
.replaceAll(/[^a-zA-Z0-9]+(\w?)/g, (...args) => args[1]?.toUpperCase() || '');
|
||||
return text[0].toUpperCase() + text.slice(1);
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate a random hexadecimal value
|
||||
*
|
||||
* @param {number} length Number of hexadecimal place values
|
||||
* @return {string} Hexadecimal number as a string
|
||||
*/
|
||||
export function randomHex(length: number) {
|
||||
return Array(length).fill(null).map(() => Math.round(Math.random() * 0xF).toString(16)).join('');
|
||||
}
|
||||
|
||||
/**
|
||||
@ -113,6 +180,32 @@ export function randomStringBuilder(length: number, letters = false, numbers = f
|
||||
}).join('');
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts text to snake_case
|
||||
*/
|
||||
export function snakeCase(str?: string) {
|
||||
if(!str) return '';
|
||||
return str.replaceAll(/(^[^a-zA-Z]+|[^a-zA-Z0-9-_])/g, '')
|
||||
.replaceAll(/([A-Z]|[0-9]+)/g, (...args) => `_${args[0].toLowerCase()}`)
|
||||
.replaceAll(/([0-9])([a-z])/g, (...args) => `${args[1]}_${args[2]}`)
|
||||
.replaceAll(/[^a-z0-9]+(\w?)/g, (...args) => `_${args[1] ?? ''}`).toLowerCase();
|
||||
}
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
@ -141,8 +234,51 @@ export function matchAll(value: string, regex: RegExp | string): RegExpExecArray
|
||||
return ret;
|
||||
}
|
||||
|
||||
/** Parts of a URL */
|
||||
export type ParsedUrl = {
|
||||
protocol?: string,
|
||||
subdomain?: string,
|
||||
domain: string,
|
||||
host: string,
|
||||
port?: number,
|
||||
path?: string,
|
||||
query?: {[name: string]: string}
|
||||
fragment?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Break a URL string into its parts for easy parsing
|
||||
*
|
||||
* @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(
|
||||
'(?:(?<protocol>[\\w\\d]+)\\:\\/\\/)?(?:(?<user>.+)\\@)?(?<host>(?<domain>[^:\\/\\?#@\\n]+)(?:\\:(?<port>\\d*))?)(?<path>\\/.*?)?(?:\\?(?<query>.*?))?(?:#(?<fragment>.*?))?$',
|
||||
'gm').exec(url);
|
||||
const groups: ParsedUrl = <any>processed?.groups ?? {};
|
||||
const domains = groups.domain.split('.');
|
||||
if(groups['port'] != null) groups.port = Number(groups.port);
|
||||
if(domains.length > 2) {
|
||||
groups.domain = domains.splice(-2, 2).join('.');
|
||||
groups.subdomain = domains.join('.');
|
||||
}
|
||||
if(groups.query) {
|
||||
const split = (<any>groups.query).split('&'), query: any = {};
|
||||
split.forEach((q: any) => {
|
||||
const [key, val] = q.split('=');
|
||||
query[key] = val;
|
||||
});
|
||||
groups.query = query;
|
||||
}
|
||||
return groups;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Create MD5 hash using native javascript
|
||||
*
|
||||
* @param d String to hash
|
||||
* @returns {string} Hashed string
|
||||
*/
|
||||
|
214
src/time.ts
214
src/time.ts
@ -1,3 +1,186 @@
|
||||
/**
|
||||
* 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 {string} format How date string will be formatted, default: `YYYY-MM-DD H:mm A`
|
||||
* @param {Date | number | string} date Date or timestamp, defaults to now
|
||||
* @param tz Set timezone offset
|
||||
* @return {string} Formated date
|
||||
*/
|
||||
export function formatDate(format = 'YYYY-MM-DD H:mm', date: Date | number | string = new Date(), 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 {
|
||||
return ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'][num] || '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 {
|
||||
return ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'][num] || 'Unknown';
|
||||
}
|
||||
|
||||
function suffix(num: number) {
|
||||
if (num % 100 >= 11 && num % 100 <= 13) return `${num}th`;
|
||||
switch (num % 10) {
|
||||
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);
|
||||
|
||||
// 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]);
|
||||
|
||||
// Token mapping
|
||||
const tokens: Record<string, string> = {
|
||||
'YYYY': date.getFullYear().toString(),
|
||||
'YY': date.getFullYear().toString().slice(2),
|
||||
'MMMM': month(date.getMonth()),
|
||||
'MMM': month(date.getMonth()).slice(0, 3),
|
||||
'MM': (date.getMonth() + 1).toString().padStart(2, '0'),
|
||||
'M': (date.getMonth() + 1).toString(),
|
||||
'DDD': doy(date).toString(),
|
||||
'DD': date.getDate().toString().padStart(2, '0'),
|
||||
'Do': suffix(date.getDate()),
|
||||
'D': date.getDate().toString(),
|
||||
'dddd': day(date.getDay()),
|
||||
'ddd': day(date.getDay()).slice(0, 3),
|
||||
'HH': date.getHours().toString().padStart(2, '0'),
|
||||
'H': date.getHours().toString(),
|
||||
'hh': (date.getHours() % 12 || 12).toString().padStart(2, '0'),
|
||||
'h': (date.getHours() % 12 || 12).toString(),
|
||||
'mm': date.getMinutes().toString().padStart(2, '0'),
|
||||
'm': date.getMinutes().toString(),
|
||||
'ss': date.getSeconds().toString().padStart(2, '0'),
|
||||
's': date.getSeconds().toString(),
|
||||
'SSS': date.getMilliseconds().toString().padStart(3, '0'),
|
||||
'A': date.getHours() >= 12 ? 'PM' : 'AM',
|
||||
'a': date.getHours() >= 12 ? 'pm' : 'am',
|
||||
'ZZ': tzOffset(t[1] * 60).replace(':', ''),
|
||||
'Z': tzOffset(t[1] * 60),
|
||||
'z': typeof tz == 'string' ? tz : (<any>t)[0]
|
||||
};
|
||||
return format.replace(/YYYY|YY|MMMM|MMM|MM|M|DDD|DD|Do|D|dddd|ddd|HH|H|hh|h|mm|m|ss|s|SSS|A|a|ZZ|Z|z/g, token => tokens[token]);
|
||||
}
|
||||
|
||||
/**
|
||||
* 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);
|
||||
}
|
||||
|
||||
/**
|
||||
* Use in conjunction with `await` to pause an async script
|
||||
*
|
||||
* @example
|
||||
* ```js
|
||||
* await sleep(1000) // Pause for 1 second
|
||||
* ```
|
||||
*
|
||||
* @param {number} ms - Time to pause for in milliseconds
|
||||
* @returns {Promise<unknown>} - Resolves promise when it's time to resume
|
||||
*/
|
||||
export function sleep(ms: number): Promise<void> {
|
||||
return new Promise(res => setTimeout(res, ms));
|
||||
}
|
||||
|
||||
/**
|
||||
* Sleep while function returns true
|
||||
*
|
||||
* @example
|
||||
* ```js
|
||||
* let loading = true;
|
||||
* setTimeout(() => wait = false, 1000);
|
||||
* await sleepWhile(() => loading); // Won't continue until loading flag is false
|
||||
* ```
|
||||
*
|
||||
* @param {() => boolean | Promise<boolean>} fn Return true to continue
|
||||
* @param {number} checkInterval Run function ever x milliseconds
|
||||
* @return {Promise<void>} Callback when sleep is over
|
||||
*/
|
||||
export async function sleepWhile(fn : () => boolean | Promise<boolean>, checkInterval = 100): Promise<void> {
|
||||
while(await fn()) await sleep(checkInterval);
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculate the number of milliseconds until date/time
|
||||
*
|
||||
@ -7,34 +190,3 @@
|
||||
export function timeUntil(date: Date | number): number {
|
||||
return (date instanceof Date ? date.getTime() : date) - (new Date()).getTime();
|
||||
}
|
||||
|
||||
/**
|
||||
* Use in conjunction with `await` to pause an async script
|
||||
*
|
||||
* @example
|
||||
* ```ts
|
||||
* async () => {
|
||||
* ...
|
||||
* await sleep(1000) // Pause for 1 second
|
||||
* ...
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @param {number} ms - Time to pause for in milliseconds
|
||||
* @returns {Promise<unknown>} - Resolves promise when it's time to resume
|
||||
*/
|
||||
export function sleep(ms: number) {
|
||||
return new Promise(res => setTimeout(res, ms));
|
||||
}
|
||||
|
||||
export function formatDate(date: Date | number | string) {
|
||||
const d = date instanceof Date ? date : new Date(date);
|
||||
return new Intl.DateTimeFormat("en-us", {
|
||||
weekday: "long",
|
||||
month: "short",
|
||||
day: "numeric",
|
||||
hour: "numeric",
|
||||
minute: "numeric",
|
||||
hour12: true
|
||||
}).format(d);
|
||||
}
|
||||
|
20
src/types.ts
Normal file
20
src/types.ts
Normal file
@ -0,0 +1,20 @@
|
||||
/**
|
||||
* Return keys on a type as an array of strings
|
||||
*
|
||||
* @example
|
||||
* ```ts
|
||||
* type Person = {
|
||||
* firstName: string;
|
||||
* lastName: string;
|
||||
* age: number;
|
||||
* }
|
||||
*
|
||||
* const keys = typeKeys<Person>();
|
||||
* console.log(keys); // Output: ["firstName", "lastName", "age"]
|
||||
* ```
|
||||
*
|
||||
* @return {Array<keyof T>} Available keys
|
||||
*/
|
||||
export function typeKeys<T extends object>() {
|
||||
return Object.keys(<T>{}) as Array<keyof T>;
|
||||
}
|
92
src/xhr.ts
92
src/xhr.ts
@ -1,92 +0,0 @@
|
||||
export type FetchInterceptor = (resp: Response, next: () => any) => any;
|
||||
|
||||
export class XHR<T> {
|
||||
private static interceptors: {[key: number]: FetchInterceptor} = {};
|
||||
static headers: Record<string, string | null> = {};
|
||||
|
||||
private interceptors: {[key: string]: FetchInterceptor} = {};
|
||||
|
||||
constructor(public readonly baseUrl: string,
|
||||
public readonly headers: Record<string, string | null> = {}
|
||||
) { }
|
||||
|
||||
static addInterceptor(fn: FetchInterceptor): () => {};
|
||||
static addInterceptor(key: string, fn: FetchInterceptor): () => {};
|
||||
static addInterceptor(keyOrFn: string | FetchInterceptor, fn?: FetchInterceptor): () => {} {
|
||||
const func: any = fn ? fn : keyOrFn;
|
||||
const key: string = typeof keyOrFn == 'string' ? keyOrFn :
|
||||
`_${Object.keys(XHR.interceptors).length.toString()}`;
|
||||
XHR.interceptors[<any>key] = func;
|
||||
return () => delete XHR.interceptors[<any>key];
|
||||
}
|
||||
|
||||
addInterceptor(fn: FetchInterceptor): () => {};
|
||||
addInterceptor(key: string, fn: FetchInterceptor): () => {};
|
||||
addInterceptor(keyOrFn: string | FetchInterceptor, fn?: FetchInterceptor): () => {} {
|
||||
const func: any = fn ? fn : keyOrFn;
|
||||
const key: string = typeof keyOrFn == 'string' ? keyOrFn :
|
||||
`_${Object.keys(this.interceptors).length.toString()}`;
|
||||
this.interceptors[<any>key] = func;
|
||||
return () => delete this.interceptors[<any>key];
|
||||
}
|
||||
|
||||
getInterceptors() {
|
||||
return [...Object.values(XHR.interceptors), ...Object.values(this.interceptors)];
|
||||
}
|
||||
|
||||
fetch<T2 = T>(href?: string, body?: any, opts: any = {}): Promise<T2> {
|
||||
const headers = {
|
||||
'Content-Type': (body && !(body instanceof FormData)) ? 'application/json' : undefined,
|
||||
...XHR.headers,
|
||||
...this.headers,
|
||||
...opts.headers
|
||||
};
|
||||
Object.keys(headers).forEach(h => { if(!headers[h]) delete headers[h]; });
|
||||
return fetch(`${this.baseUrl}${href || ''}`.replace(/([^:]\/)\/+/g, '$1'), {
|
||||
headers,
|
||||
method: opts.method || (body ? 'POST' : 'GET'),
|
||||
body: (headers['Content-Type']?.startsWith('application/json') && body) ? JSON.stringify(body) : body
|
||||
}).then(async resp => {
|
||||
for(let fn of this.getInterceptors()) {
|
||||
const wait = new Promise(res =>
|
||||
fn(resp, () => res(null)));
|
||||
await wait;
|
||||
}
|
||||
if(resp.headers.has('Content-Type')) {
|
||||
if(resp.headers.get('Content-Type')?.startsWith('application/json')) return await resp.json();
|
||||
if(resp.headers.get('Content-Type')?.startsWith('text/plain')) return await resp.text();
|
||||
}
|
||||
return resp;
|
||||
});
|
||||
}
|
||||
|
||||
delete<T2 = void>(url?: string, opts?: any): Promise<T2> {
|
||||
return this.fetch(url, null, {method: 'delete', ...opts});
|
||||
}
|
||||
|
||||
get<T2 = T>(url?: string, opts?: any): Promise<T2> {
|
||||
return this.fetch(url, null, {method: 'get', ...opts});
|
||||
}
|
||||
|
||||
patch<T2 = T>(data: T2, url?: string, opts?: any): Promise<T2> {
|
||||
return this.fetch(url, data, {method: 'patch', ...opts});
|
||||
}
|
||||
|
||||
post<T2 = T>(data: T2, url?: string, opts?: any): Promise<T2> {
|
||||
return this.fetch(url, data, {method: 'post', ...opts});
|
||||
}
|
||||
|
||||
put<T2 = T>(data: Partial<T2>, url?: string, opts?: any): Promise<T2> {
|
||||
return this.fetch(url, data, {method: 'put', ...opts});
|
||||
}
|
||||
|
||||
new<T2 = T>(href: string, headers: Record<string, string | null>): XHR<T2> {
|
||||
const fetch = new XHR<T2>(`${this.baseUrl}${href}`, {
|
||||
...this.headers,
|
||||
...headers,
|
||||
});
|
||||
Object.entries(this.interceptors).map(([key, value]) =>
|
||||
fetch.addInterceptor(key, value));
|
||||
return fetch;
|
||||
}
|
||||
}
|
@ -1,4 +1,4 @@
|
||||
import {sleep, urlParser} from '../src';
|
||||
import {sleep, parseUrl} from '../src';
|
||||
|
||||
describe('Miscellanies Utilities', () => {
|
||||
describe('sleep', () => {
|
||||
@ -12,7 +12,7 @@ describe('Miscellanies Utilities', () => {
|
||||
|
||||
describe('urlParser', () => {
|
||||
test('localhost w/ port', () => {
|
||||
const parsed = urlParser('http://localhost:4200/some/path?q1=test1&q2=test2#frag');
|
||||
const parsed = parseUrl('http://localhost:4200/some/path?q1=test1&q2=test2#frag');
|
||||
expect(parsed.protocol).toStrictEqual('http');
|
||||
expect(parsed.host).toStrictEqual('localhost:4200');
|
||||
expect(parsed.domain).toStrictEqual('localhost');
|
||||
@ -23,7 +23,7 @@ describe('Miscellanies Utilities', () => {
|
||||
});
|
||||
|
||||
test('advanced URL', () => {
|
||||
const parsed = urlParser('https://sub.domain.example.com/some/path?q1=test1&q2=test2#frag');
|
||||
const parsed = parseUrl('https://sub.domain.example.com/some/path?q1=test1&q2=test2#frag');
|
||||
expect(parsed.protocol).toStrictEqual('https');
|
||||
expect(parsed.host).toStrictEqual('sub.domain.example.com');
|
||||
expect(parsed.domain).toStrictEqual('example.com');
|
||||
|
@ -29,28 +29,6 @@ describe('Object Utilities', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('deepCopy', () => {
|
||||
const copy = deepCopy(TEST_OBJECT);
|
||||
test('Array of arrays', () => {
|
||||
const a = [[1, 2], [3, 4]];
|
||||
const b = deepCopy(a);
|
||||
b[0][1] = 5;
|
||||
expect(a).not.toEqual(b);
|
||||
});
|
||||
test('Change array inside object', () => {
|
||||
copy.b[1] = [1, 1, 1];
|
||||
expect(copy.b[1]).not.toEqual(TEST_OBJECT.b[1]);
|
||||
});
|
||||
test('Change object inside object', () => {
|
||||
copy.g = {h: Math.random()};
|
||||
expect(copy.g).not.toEqual(TEST_OBJECT.g);
|
||||
});
|
||||
test('Change object property inside nested array', () => {
|
||||
copy.c.d[0][0].e = -1;
|
||||
expect(copy.c.d[0][0].e).not.toEqual(TEST_OBJECT.c.d[0][0].e);
|
||||
});
|
||||
});
|
||||
|
||||
describe('dotNotation', () => {
|
||||
test('no object or properties', () => {
|
||||
expect(dotNotation(undefined, 'z')).toStrictEqual(undefined);
|
||||
|
@ -1,19 +1,20 @@
|
||||
{
|
||||
"include": [
|
||||
"src/**/*"
|
||||
],
|
||||
"include": ["src"],
|
||||
"compilerOptions": {
|
||||
"composite": true,
|
||||
"declaration": true,
|
||||
"declarationMap": true,
|
||||
"experimentalDecorators": true,
|
||||
"esModuleInterop": true,
|
||||
"inlineSourceMap": true,
|
||||
"lib": ["ESNext", "DOM"],
|
||||
"module": "ES6",
|
||||
"moduleResolution": "Node",
|
||||
"outDir": "./dist",
|
||||
"strict": true,
|
||||
"target": "ESNext"
|
||||
"target": "ES2020",
|
||||
"useDefineForClassFields": true,
|
||||
"module": "ESNext",
|
||||
"lib": ["ESNext", "DOM", "DOM.Iterable"],
|
||||
"skipLibCheck": true,
|
||||
|
||||
/* Bundler mode */
|
||||
"moduleResolution": "bundler",
|
||||
"allowImportingTsExtensions": true,
|
||||
"resolveJsonModule": true,
|
||||
"isolatedModules": true,
|
||||
"noEmit": true,
|
||||
|
||||
/* Linting */
|
||||
"strict": true
|
||||
}
|
||||
}
|
||||
|
@ -6,12 +6,15 @@ export default defineConfig({
|
||||
build: {
|
||||
lib: {
|
||||
entry: resolve(process.cwd(), 'src/index.ts'),
|
||||
name: 'js-utilities',
|
||||
name: 'utils',
|
||||
fileName: (module, entryName) => {
|
||||
if(module == 'es') return 'js-utilities.mjs';
|
||||
if(module == 'umd') return 'js-utilities.js';
|
||||
if(module == 'es') return 'index.mjs';
|
||||
if(module == 'umd') return 'index.cjs';
|
||||
}
|
||||
},
|
||||
emptyOutDir: true,
|
||||
minify: false,
|
||||
sourcemap: true
|
||||
},
|
||||
plugins: [dts()],
|
||||
});
|
||||
|
Loading…
x
Reference in New Issue
Block a user