Compare commits

..

99 Commits

Author SHA1 Message Date
67ae86d69b Added India Standard Time to formatDate
All checks were successful
Build / Build NPM Project (push) Successful in 33s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 1m42s
2024-11-20 10:58:31 -05:00
87db4d4755 Combined adjustTz into formatDate
Some checks failed
Build / Tag Version (push) Has been cancelled
Build / Publish Documentation (push) Has been cancelled
Build / Build NPM Project (push) Has been cancelled
2024-11-20 10:56:51 -05:00
0fb1e13ba0 Fixed timezone adjust
All checks were successful
Build / Build NPM Project (push) Successful in 1m12s
Build / Tag Version (push) Successful in 11s
Build / Publish Documentation (push) Successful in 2m4s
2024-11-20 10:04:17 -05:00
ff4401934c Fixed formatDate month shortform
All checks were successful
Build / Build NPM Project (push) Successful in 1m21s
Build / Tag Version (push) Successful in 13s
Build / Publish Documentation (push) Successful in 1m57s
2024-11-16 11:02:32 -05:00
ce3c8d012a Fixed import
All checks were successful
Build / Build NPM Project (push) Successful in 1m5s
Build / Tag Version (push) Successful in 14s
Build / Publish Documentation (push) Successful in 2m2s
2024-11-15 16:22:01 -05:00
a86e8350ee bump 0.22.9
Some checks failed
Build / Build NPM Project (push) Failing after 24s
Build / Tag Version (push) Has been skipped
Build / Publish Documentation (push) Has been skipped
2024-11-15 16:18:45 -05:00
7b4e17e4c4 Added advanced search function
Some checks failed
Build / Build NPM Project (push) Failing after 20s
Build / Tag Version (push) Has been skipped
Build / Publish Documentation (push) Has been skipped
2024-11-15 16:17:52 -05:00
fa66820c76 more time utils
All checks were successful
Build / Build NPM Project (push) Successful in 38s
Build / Tag Version (push) Successful in 8s
Build / Publish Documentation (push) Successful in 2m27s
2024-11-14 23:29:58 -05:00
49a2df8cd4 Fixed timezone format
All checks were successful
Build / Build NPM Project (push) Successful in 1m15s
Build / Tag Version (push) Successful in 13s
Build / Publish Documentation (push) Successful in 1m57s
2024-11-14 22:58:24 -05:00
ccf3fcb043 fixed fromCsv escaping quotes & letter headers
All checks were successful
Build / Build NPM Project (push) Successful in 37s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 1m46s
2024-11-09 17:27:05 -05:00
341ef37205 Added fromCsv
All checks were successful
Build / Build NPM Project (push) Successful in 37s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 1m43s
2024-11-09 16:30:05 -05:00
0eab2630ad added fileText method
All checks were successful
Build / Build NPM Project (push) Successful in 37s
Build / Tag Version (push) Successful in 6s
Build / Publish Documentation (push) Successful in 2m21s
2024-11-09 15:35:05 -05:00
2f59a9d02e improved toCSV
All checks were successful
Build / Build NPM Project (push) Successful in 41s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 1m41s
2024-11-09 13:49:04 -05:00
ce2f32dd45 Fixed PathEvents double slash
All checks were successful
Build / Build NPM Project (push) Successful in 1m10s
Build / Tag Version (push) Successful in 13s
Build / Publish Documentation (push) Successful in 1m54s
2024-11-08 18:49:11 -05:00
ce40b5b1e7 Deprecated old methods
All checks were successful
Build / Build NPM Project (push) Successful in 39s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 1m41s
2024-11-07 10:46:56 -05:00
2500bcdcf1 Added string splice and updated dateFormat to accept custom format stings
All checks were successful
Build / Build NPM Project (push) Successful in 1m6s
Build / Tag Version (push) Successful in 13s
Build / Publish Documentation (push) Successful in 1m50s
2024-11-07 10:30:43 -05:00
db18c010aa Added adjusted interval & set errorFromCode to always return an error even on 200's
All checks were successful
Build / Build NPM Project (push) Successful in 1m16s
Build / Tag Version (push) Successful in 14s
Build / Publish Documentation (push) Successful in 2m1s
2024-10-29 10:41:25 -04:00
b292d5ed17 PathEvents has none fix
All checks were successful
Build / Build NPM Project (push) Successful in 36s
Build / Tag Version (push) Successful in 10s
Build / Publish Documentation (push) Successful in 1m47s
2024-10-23 21:39:42 -04:00
a1ea8cdf67 Added filter function to path events
All checks were successful
Build / Build NPM Project (push) Successful in 37s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 1m46s
2024-10-23 14:13:47 -04:00
fbbe3c99ef Updated ASet & Path Events
All checks were successful
Build / Build NPM Project (push) Successful in 37s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 1m43s
2024-10-17 10:24:18 -04:00
1c1a3f6a6e Updated ASet & Path Events
All checks were successful
Build / Build NPM Project (push) Successful in 36s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 1m40s
2024-10-17 00:36:53 -04:00
2dce1ad9ac Object logging with formatting
All checks were successful
Build / Build NPM Project (push) Successful in 39s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 35s
2024-10-16 20:32:41 -04:00
cebfd2c508 Object logging with formatting
All checks were successful
Build / Build NPM Project (push) Successful in 40s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 35s
2024-10-16 20:28:56 -04:00
7c5cf3535d Handle logging objects
All checks were successful
Build / Build NPM Project (push) Successful in 39s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 35s
2024-10-16 20:21:35 -04:00
847b493772 Handle logging objects
All checks were successful
Build / Build NPM Project (push) Successful in 38s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 34s
2024-10-16 19:55:35 -04:00
b1005227ab Added PathError for easy detection
All checks were successful
Build / Build NPM Project (push) Successful in 43s
Build / Tag Version (push) Successful in 8s
Build / Publish Documentation (push) Successful in 38s
2024-10-16 19:52:47 -04:00
3a389de72e Cache localstorage fix
All checks were successful
Build / Build NPM Project (push) Successful in 38s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 35s
2024-10-15 16:44:23 -04:00
151465aa65 Cache localstorage fix
All checks were successful
Build / Build NPM Project (push) Successful in 39s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 36s
2024-10-15 16:39:29 -04:00
b103b6f786 Cache localstorage fix
All checks were successful
Build / Build NPM Project (push) Successful in 38s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 34s
2024-10-15 16:35:11 -04:00
3b486310de Deleting lock file, seems to mess up build
All checks were successful
Build / Build NPM Project (push) Successful in 1m4s
Build / Tag Version (push) Successful in 11s
Build / Publish Documentation (push) Successful in 46s
2024-10-15 13:51:00 -04:00
8699fb49ff New lock file
Some checks failed
Build / Build NPM Project (push) Failing after 18s
Build / Tag Version (push) Has been skipped
Build / Publish Documentation (push) Has been skipped
2024-10-15 13:49:52 -04:00
fdb29e7984 New lock file
Some checks failed
Build / Tag Version (push) Blocked by required conditions
Build / Publish Documentation (push) Blocked by required conditions
Build / Build NPM Project (push) Has been cancelled
2024-10-15 13:49:17 -04:00
274c22bb83 Fixed localStorage access on node environments
Some checks failed
Build / Build NPM Project (push) Failing after 15s
Build / Tag Version (push) Has been skipped
Build / Publish Documentation (push) Has been skipped
2024-10-15 13:46:11 -04:00
b21f462d35 Added clear function to cache
All checks were successful
Build / Build NPM Project (push) Successful in 37s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 35s
2024-10-14 21:07:59 -04:00
0f10aebfd2 bubble up all fetch errors in the http helper
All checks were successful
Build / Build NPM Project (push) Successful in 40s
Build / Tag Version (push) Successful in 8s
Build / Publish Documentation (push) Successful in 36s
2024-10-14 20:46:32 -04:00
1af23ac544 Fixed cache localstorage
All checks were successful
Build / Build NPM Project (push) Successful in 37s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 34s
2024-10-14 20:04:29 -04:00
494cfaaccd Added localStorage support to cache
All checks were successful
Build / Build NPM Project (push) Successful in 41s
Build / Tag Version (push) Successful in 8s
Build / Publish Documentation (push) Successful in 41s
2024-10-14 18:51:24 -04:00
23df6ad265 Renamed PathEventEmitter to follow convention
All checks were successful
Build / Build NPM Project (push) Successful in 27s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 27s
2024-10-14 14:09:51 -04:00
2fda11f3b7 Renamed PathEventEmitter to follow convention
All checks were successful
Build / Build NPM Project (push) Successful in 27s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 26s
2024-10-14 14:06:06 -04:00
379de273c4 Added path-events
All checks were successful
Build / Build NPM Project (push) Successful in 31s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 28s
2024-10-14 13:52:03 -04:00
c51239d12b Bump 0.18.2
All checks were successful
Build / Build NPM Project (push) Successful in 25s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 26s
2024-10-12 12:30:23 -04:00
e4229296c1 Added escapeRegex
All checks were successful
Build / Build NPM Project (push) Successful in 59s
Build / Tag Version (push) Successful in 14s
Build / Publish Documentation (push) Successful in 42s
2024-10-12 12:27:45 -04:00
b93ed45521 Renamed sleepUntil to sleepWhile, it was misleading
All checks were successful
Build / Build NPM Project (push) Successful in 1m5s
Build / Tag Version (push) Successful in 14s
Build / Publish Documentation (push) Successful in 39s
2024-10-07 15:40:14 -04:00
3e8f5cc00b Add or remove multiple elements from ASet at once
All checks were successful
Build / Build NPM Project (push) Successful in 30s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 27s
2024-10-06 19:14:36 -04:00
54a2880391 Updated docs
All checks were successful
Build / Build NPM Project (push) Successful in 27s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 25s
2024-10-01 15:44:49 -04:00
b7aeee4706 Fixing docker container
All checks were successful
Build / Build NPM Project (push) Successful in 25s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 25s
2024-10-01 15:39:24 -04:00
b3eab0d6c9 Created docs docker container
All checks were successful
Build / Build NPM Project (push) Successful in 26s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 19s
2024-10-01 15:22:48 -04:00
ad4194a981 Fixed extracting version number during build
Some checks failed
Build / Build NPM Project (push) Successful in 27s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Failing after 8s
2024-10-01 15:13:47 -04:00
e1f22a01a6 Added docs container
Some checks failed
Build / Build NPM Project (push) Successful in 31s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Failing after 5s
2024-10-01 15:08:52 -04:00
91c0858d9f Added var-persist
All checks were successful
Build / Build NPM Project (push) Successful in 28s
Build / Tag Version (push) Successful in 6s
2024-09-30 21:43:13 -04:00
8094b6507f Updated cache indexing signature
All checks were successful
Build / Build NPM Project (push) Successful in 26s
Build / Tag Version (push) Successful in 7s
2024-09-30 19:39:06 -04:00
e40f410830 Removed window reference from jwtDecode
All checks were successful
Build / Build NPM Project (push) Successful in 27s
Build / Tag Version (push) Successful in 7s
2024-09-30 16:18:07 -04:00
c1043e65e2 Added jwtDecode function
All checks were successful
Build / Build NPM Project (push) Successful in 27s
Build / Tag Version (push) Successful in 7s
2024-09-30 16:02:21 -04:00
67d9928a61 Added jwtDecode function
All checks were successful
Build / Build NPM Project (push) Successful in 31s
Build / Tag Version (push) Successful in 6s
2024-09-30 15:58:37 -04:00
e6636d373b Updated cache
All checks were successful
Build / Build NPM Project (push) Successful in 26s
Build / Tag Version (push) Successful in 6s
2024-09-28 14:41:43 -04:00
811d797e1b Updated cache
All checks were successful
Build / Build NPM Project (push) Successful in 25s
Build / Tag Version (push) Successful in 6s
2024-09-28 10:45:03 -04:00
0909c4f648 Updated cache
All checks were successful
Build / Build NPM Project (push) Successful in 25s
Build / Tag Version (push) Successful in 6s
2024-09-28 10:30:20 -04:00
8384d6a299 Added new cache object
All checks were successful
Build / Build NPM Project (push) Successful in 30s
Build / Tag Version (push) Successful in 6s
2024-09-28 09:56:09 -04:00
19251244d2 sleepUntil async support
All checks were successful
Build / Build NPM Project (push) Successful in 39s
Build / Tag Version (push) Successful in 8s
2024-09-26 23:45:46 -04:00
51549db3d9 Updated download functions & added CSV serializer
All checks were successful
Build / Build NPM Project (push) Successful in 25s
Build / Tag Version (push) Successful in 6s
2024-09-22 03:35:12 -04:00
3bf8c7bd09 Removed deep copy tests since it was replaced with a native function
All checks were successful
Build / Build NPM Project (push) Successful in 43s
Build / Tag Version (push) Successful in 6s
2024-09-22 03:13:22 -04:00
e8e56a3f72 Fixed doc output
Some checks failed
Build / Build NPM Project (push) Failing after 21s
Build / Tag Version (push) Has been skipped
2024-09-22 03:09:52 -04:00
98f867ed4e Updated readme 2024-09-22 02:50:26 -04:00
94cea19728 Updated docs submodule 2024-09-22 02:44:36 -04:00
3896949fc1 Docs update
Some checks failed
Build / Build NPM Project (push) Failing after 28s
Build / Tag Version (push) Has been skipped
2024-09-22 02:38:13 -04:00
a0f0699a85 Added format bytes helper
All checks were successful
Build / Build NPM Project (push) Successful in 24s
Build / Tag Version (push) Successful in 7s
2024-09-11 18:33:10 -04:00
adcd6eaf79 Added PUT method to http helper
All checks were successful
Build / Build NPM Project (push) Successful in 30s
Build / Tag Version (push) Successful in 7s
2024-09-11 17:34:56 -04:00
afb6ca0803 Added function to create errors from status codes
All checks were successful
Build / Build NPM Project (push) Successful in 25s
Build / Tag Version (push) Successful in 6s
2024-09-04 18:48:15 -04:00
e699f8a634 Added new error codes
All checks were successful
Build / Build NPM Project (push) Successful in 45s
Build / Tag Version (push) Successful in 6s
2024-09-04 10:47:44 -04:00
c7dd91e9cd Added new error codes
Some checks failed
Build / Tag Version (push) Blocked by required conditions
Build / Build NPM Project (push) Has been cancelled
2024-09-04 10:47:36 -04:00
20f36cc573 Added some doc strings & sleepUntil function
All checks were successful
Build / Build NPM Project (push) Successful in 50s
Build / Tag Version (push) Successful in 7s
2024-08-27 11:41:22 -04:00
57446ef09a bump
All checks were successful
Build / Build NPM Project (push) Successful in 29s
Build / Tag Version (push) Successful in 7s
2024-08-21 11:11:51 -04:00
6d13df39f5 Added JSONAttemptParse & fixed uploadProgress response
All checks were successful
Build / Build NPM Project (push) Successful in 28s
Build / Tag Version (push) Successful in 7s
2024-08-17 14:21:05 -04:00
2d63db0ebb Added formData helper
All checks were successful
Build / Build NPM Project (push) Successful in 28s
Build / Tag Version (push) Successful in 7s
2024-08-15 12:55:57 -04:00
535fc0271e Messing around with http decoding
All checks were successful
Build / Build NPM Project (push) Successful in 24s
Build / Tag Version (push) Successful in 7s
2024-08-13 15:41:47 -04:00
d587b92ea4 Messing around with http decoding
All checks were successful
Build / Build NPM Project (push) Successful in 24s
Build / Tag Version (push) Successful in 7s
2024-08-13 15:38:20 -04:00
26c6084052 Messing around with http decoding
All checks were successful
Build / Build NPM Project (push) Successful in 24s
Build / Tag Version (push) Successful in 7s
2024-08-13 15:21:56 -04:00
874bba59d3 Messing around with http decoding
All checks were successful
Build / Build NPM Project (push) Successful in 24s
Build / Tag Version (push) Successful in 7s
2024-08-13 15:19:07 -04:00
948fba3a2c Allow disabling response decoding
All checks were successful
Build / Build NPM Project (push) Successful in 49s
Build / Tag Version (push) Successful in 8s
2024-08-13 14:48:48 -04:00
a168b03caf Renamed entry point to index
All checks were successful
Build / Build NPM Project (push) Successful in 47s
Build / Tag Version (push) Successful in 7s
2024-08-09 12:27:44 -04:00
75160b7dbc Fixed upload headers
All checks were successful
Build / Build NPM Project (push) Successful in 22s
Build / Tag Version (push) Successful in 4s
2024-07-19 10:16:31 -04:00
af887a0bfb Fixed http body
All checks were successful
Build / Build NPM Project (push) Successful in 22s
Build / Tag Version (push) Successful in 4s
2024-07-19 10:05:47 -04:00
7626c20f08 Improved http
All checks were successful
Build / Build NPM Project (push) Successful in 22s
Build / Tag Version (push) Successful in 5s
2024-07-19 09:24:53 -04:00
6998616445 Fixed import
All checks were successful
Build / Build NPM Project (push) Successful in 22s
Build / Tag Version (push) Successful in 4s
2024-07-19 09:02:42 -04:00
627757ff6d Added generics to upload function
All checks were successful
Build / Build NPM Project (push) Successful in 22s
Build / Tag Version (push) Successful in 4s
2024-07-19 08:59:15 -04:00
0a775f919b Added filebrowser & Merged a bunch of functions into file utilities
All checks were successful
Build / Build NPM Project (push) Successful in 23s
Build / Tag Version (push) Successful in 4s
2024-07-19 08:45:33 -04:00
7063b80bdd Added download blob function
All checks were successful
Build / Build NPM Project (push) Successful in 22s
Build / Tag Version (push) Successful in 5s
2024-07-19 08:33:26 -04:00
f3049160b6 Fixed imports
All checks were successful
Build / Build NPM Project (push) Successful in 21s
Build / Tag Version (push) Successful in 4s
2024-07-19 00:26:30 -04:00
e21273ddb2 Fixed exports
All checks were successful
Build / Build NPM Project (push) Successful in 21s
Build / Tag Version (push) Successful in 4s
2024-07-19 00:22:00 -04:00
8d3b427c1b Fix build?
All checks were successful
Build / Build NPM Project (push) Successful in 24s
Build / Tag Version (push) Successful in 4s
2024-07-19 00:09:40 -04:00
87857a01c5 Fix build?
Some checks failed
Build / Build NPM Project (push) Failing after 8s
Build / Tag Version (push) Has been skipped
2024-07-19 00:08:39 -04:00
535e579b43 Fix build?
Some checks failed
Build / Build NPM Project (push) Failing after 7s
Build / Tag Version (push) Has been skipped
2024-07-19 00:06:17 -04:00
2934f86530 Fix build?
Some checks failed
Build / Build NPM Project (push) Failing after 8s
Build / Tag Version (push) Has been skipped
2024-07-19 00:04:16 -04:00
0693397164 Added upload function with PromiseProgress support
Some checks failed
Build / Build NPM Project (push) Failing after 29s
Build / Tag Version (push) Has been skipped
2024-07-18 23:59:54 -04:00
2a878b7962 Updated XHR to HTTP with PromiseProgress support 2024-07-18 23:59:12 -04:00
7b2d4ba119 updated xhr error handling
All checks were successful
Build / Build NPM Project (push) Successful in 42s
Build / Tag Version (push) Successful in 4s
2024-06-25 09:58:02 -04:00
1a4e732fd5 deepMerge fix
All checks were successful
Build / Build NPM Project (push) Successful in 22s
Build / Tag Version (push) Successful in 5s
2024-06-18 21:08:18 -04:00
3a039c935f export deepMerge
All checks were successful
Build / Build NPM Project (push) Successful in 22s
Build / Tag Version (push) Successful in 4s
2024-06-18 20:19:10 -04:00
ac5b0b8b41 Added merge object
All checks were successful
Build / Build NPM Project (push) Successful in 21s
Build / Tag Version (push) Successful in 5s
2024-06-18 19:31:08 -04:00
33 changed files with 1739 additions and 5317 deletions

View File

@ -9,34 +9,19 @@ jobs:
build: build:
name: Build NPM Project name: Build NPM Project
runs-on: ubuntu-latest runs-on: ubuntu-latest
container: container: node:20-alpine
image: node
volumes:
- '/mnt/swarm/gitea/runner/cache:/cache'
steps: steps:
- name: Clone Repository - name: Clone Repository
uses: ztimson/actions/clone@develop uses: ztimson/actions/clone@develop
- name: Restore node_modules - name: Install & Build
uses: ztimson/actions/cache/restore@develop run: |
with: npm i
key: node_modules npm run build
- name: Install Dependencies
run: npm i
- name: Build Project
run: npm run build
- name: Test - name: Test
run: npm run test:coverage 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 - name: Upload to Registry
uses: ztimson/actions/npm/publish@develop uses: ztimson/actions/npm/publish@develop
@ -63,3 +48,13 @@ jobs:
uses: ztimson/actions/tag@develop uses: ztimson/actions/tag@develop
with: with:
tag: ${{env.VERSION}} tag: ${{env.VERSION}}
docs:
name: Publish Documentation
needs: build
uses: ztimson/actions/.github/workflows/docker.yaml@develop
with:
name: ztimson/utils
repository: ${{github.server_url}}/${{github.repository}}.git
pass: ${{secrets.DEPLOY_TOKEN}}

5
.gitmodules vendored Normal file
View 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
View 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
View File

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

91
README.md Normal file
View 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 -->
[![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/utils/tags&query=$[0].name)](https://git.zakscode.com/ztimson/utils/tags)
[![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/utils&query=open_pr_counter)](https://git.zakscode.com/ztimson/utils/pulls)
[![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/utils&query=open_issues_count)](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
[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](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

Submodule docs added at dbf5d8cd07

16
index.html Normal file
View File

@ -0,0 +1,16 @@
<!Doctype html>
<html>
<head>
<title>@ztimson/utils sandbox</title>
</head>
<body>
<script type="module">
import {formatDate} from './dist/index.mjs';
console.log(formatDate(new Date(), 'HH:mm:ss z', 5));
console.log(formatDate(new Date(), 'HH:mm:ss z', 0));
console.log(formatDate(new Date(), 'HH:mm:ss z', -5));
</script>
</body>
</html>

5005
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,6 +1,6 @@
{ {
"name": "@ztimson/utils", "name": "@ztimson/utils",
"version": "0.11.3", "version": "0.23.0",
"description": "Utility library", "description": "Utility library",
"author": "Zak Timson", "author": "Zak Timson",
"license": "MIT", "license": "MIT",
@ -9,18 +9,19 @@
"type": "git", "type": "git",
"url": "https://git.zakscode.com/ztimson/js-utilities" "url": "https://git.zakscode.com/ztimson/js-utilities"
}, },
"main": "./dist/utils.cjs", "main": "./dist/index.cjs",
"module": "./dist/utils.mjs", "module": "./dist/index.mjs",
"types": "./dist/index.d.ts", "types": "./dist/index.d.ts",
"exports": { "exports": {
".": { ".": {
"import": "./dist/utils.mjs", "import": "./dist/index.mjs",
"require": "./dist/utils.cjs", "require": "./dist/index.cjs",
"types": "./dist/index.d.ts" "types": "./dist/index.d.ts"
} }
}, },
"scripts": { "scripts": {
"build": "npx tsc && npx vite build", "build": "npx tsc && npx vite build",
"docs": "typedoc --cleanOutputDir false --out ./docs --entryPoints src/**/*.ts --readme none",
"test": "npx jest", "test": "npx jest",
"test:coverage": "npx jest --coverage", "test:coverage": "npx jest --coverage",
"watch": "npx vite build --watch" "watch": "npx vite build --watch"
@ -30,6 +31,7 @@
"jest": "^29.7.0", "jest": "^29.7.0",
"jest-junit": "^16.0.0", "jest-junit": "^16.0.0",
"ts-jest": "^29.1.2", "ts-jest": "^29.1.2",
"typedoc": "^0.26.7",
"typescript": "^5.3.3", "typescript": "^5.3.3",
"vite": "^5.0.12", "vite": "^5.0.12",
"vite-plugin-dts": "^3.7.2" "vite-plugin-dts": "^3.7.2"

View File

@ -1,10 +1,32 @@
import {dotNotation, isEqual} from './objects'; 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[] { export function addUnique<T>(array: T[], el: T): T[] {
if(array.indexOf(el) === -1) array.push(el); if(array.indexOf(el) === -1) array.push(el);
return array; 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[] { export function arrayDiff(a: any[], b: any[]): any[] {
return makeUnique([ return makeUnique([
...a.filter(v1 => !b.includes((v2: any) => isEqual(v1, v2))), ...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 * 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[]) { export function makeUnique(arr: any[]) {
for(let i = arr.length - 1; i >= 0; i--) { for(let i = arr.length - 1; i >= 0; i--) {
if(arr.slice(0, i).find(n => isEqual(n, arr[i]))) arr.splice(i, 1); 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 * @param {T[] | T} value Value that should be an array
* @returns {T[]} Value in an array * @returns {T[]} Value in an array
*/ */

View File

@ -1,57 +1,125 @@
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 { export class ASet<T> extends Array {
/** Number of elements in set */
get size() { get size() {
return this.length; 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[] = []) { constructor(elements: T[] = []) {
super(); super();
if(!!elements?.['forEach']) if(!!elements?.['forEach'])
elements.forEach(el => this.add(el)); elements.forEach(el => this.add(el));
} }
add(el: T) { /**
if(!this.has(el)) this.push(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(el: T) { /**
* Delete elements from set
* @param items Elements that will be deleted
*/
delete(...items: T[]) {
items.forEach(el => {
const index = this.indexOf(el); const index = this.indexOf(el);
if(index != -1) this.slice(index, 1); if(index != -1) this.splice(index, 1);
})
return this;
} }
/**
* 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>) { difference(set: ASet<T>) {
return new ASet<T>(this.reduce((acc, el) => { return new ASet<T>(this.filter(el => !set.has(el)));
if(!set.has(el)) acc.push(el);
return acc;
}, []));
} }
/**
* Check if set includes element
* @param {T} el Element to look for
* @return {boolean} True if element was found, false otherwise
*/
has(el: T) { has(el: T) {
return this.indexOf(el) != -1; return this.indexOf(el) != -1;
} }
intersection(set: ASet<T>) { /**
return new ASet<T>(this.reduce((acc, el) => { * Find index number of element, or -1 if it doesn't exist. Matches by equality not reference
if(set.has(el)) acc.push(el); *
return acc; * @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>) { isDisjointFrom(set: ASet<T>) {
return this.intersection(set).size == 0; 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>) { isSubsetOf(set: ASet<T>) {
return this.findIndex(el => !set.has(el)) == -1; 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>) { isSuperset(set: ASet<T>) {
return set.findIndex(el => !this.has(el)) == -1; 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>) { symmetricDifference(set: ASet<T>) {
return new ASet([...this.difference(set), ...set.difference(this)]); 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>) { union(set: ASet<T> | Array<T>) {
return new ASet([...this, ...set]); return new ASet([...this, ...set]);
} }

168
src/cache.ts Normal file
View File

@ -0,0 +1,168 @@
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 target.store[prop as K];
},
set: (target: this, prop: string | symbol, value: any) => {
if (prop in target) (target as any)[prop] = value;
else target.store[prop as K] = value;
return true;
}
});
}
private getKey(value: T): K {
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 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 this.store[key];
}
/**
* Get a list of cached keys
*
* @return {K[]} Array of keys
*/
keys(): K[] {
return <K[]>Object.keys(this.store);
}
/**
* Get map of cached items
*
* @return {Record<K, T>}
*/
map(): Record<K, T> {
return structuredClone(this.store);
}
/**
* Add an item to the cache manually specifying the key
*
* @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();
}

56
src/csv.ts Normal file
View File

@ -0,0 +1,56 @@
import {ASet} from './aset.ts';
import {dotNotation, flattenObj, JSONSanitize} from './objects.ts';
import {LETTER_LIST} from './string.ts';
export function fromCsv<T = any>(csv: string, hasHeaders=true): T[] {
const row = csv.split('\n');
let headers: any = hasHeaders ? row.splice(0, 1)[0] : null;
if(headers) headers = headers.match(/(?:[^,"']+|"[^"]*"|'[^']*')+/g);
return <T[]>row.map(r => {
function parseLine(line: string): (string | null)[] {
const parts = line.split(','), columns: string[] = [];
let quoted = false;
for(const p of parts) {
if(quoted) columns[columns.length - 1] = columns.at(-1) + ',' + p;
else columns.push(p);
if(/[^"]"$/g.test(p)) {
quoted = false;
} else if(/^"[^"]/g.test(p)) {
quoted = true;
}
}
return columns;
}
const props = parseLine(r);
const h = headers || (Array(props.length).fill(null).map((r, i) => {
let letter = '';
const first = i / 26;
if(first > 1) letter += LETTER_LIST[Math.floor(first - 1)];
letter += LETTER_LIST[i % 26];
return letter;
}));
return h.reduce((acc: any, h: any, i: number) => {
dotNotation(acc, h, props[i]);
return acc;
}, {});
})
}
/**
* Convert an object to a CSV string
*
* @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 headers = new ASet(target.reduce((acc, row) => [...acc, ...Object.keys(flatten ? flattenObj(row) : row)], []));
return [
headers.join(','),
...target.map(row => headers.map((h: string) => {
const value = dotNotation<any>(row, h);
return (typeof value == 'object' && value != null) ? '"' + JSONSanitize(value).replaceAll('"', '""') + '"' : value;
}).join(','))
].join('\n');
}

View File

@ -1,8 +0,0 @@
export function download(href: any, name: string) {
const a = document.createElement('a');
a.href = href;
a.download = name;
document.body.appendChild(a);
a.click();
document.body.removeChild(a);
}

View File

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

View File

@ -53,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 { export class ForbiddenError extends CustomError {
static code = 403; static code = 403;
@ -77,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 { export class InternalServerError extends CustomError {
static code = 500; static code = 500;
@ -88,3 +124,88 @@ export class InternalServerError extends CustomError {
return (<any>err).constructor.code == this.code; 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);
}
}

110
src/files.ts Normal file
View File

@ -0,0 +1,110 @@
import {makeArray} from './array.ts';
import {JSONAttemptParse} from './objects.ts';
import {PromiseProgress} from './promise-progress';
/**
* 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 = `${date.getFullYear()}-${(date.getMonth() + 1).toString().padStart(2, '0')}-${date.getDate().toString().padStart(2, '0')}_${date.getHours().toString().padStart(2, '0')}-${date.getMinutes().toString().padStart(2, '0')}-${date.getSeconds().toString().padStart(2, '0')}`;
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);
});
}

126
src/http.ts Normal file
View File

@ -0,0 +1,126 @@
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;
}
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 || '')).replace(/([^:]\/)\/+/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.data = new Response(stream);
if(opts.decode == null || opts.decode) {
const content = resp.headers.get('Content-Type')?.toLowerCase();
if(content?.includes('form')) resp.data = <T>await resp.data.formData();
else if(content?.includes('json')) resp.data = <T>await resp.data.json();
else if(content?.includes('text')) resp.data = <T>await resp.data.text();
else if(content?.includes('application')) resp.data = <T>await resp.data.blob();
}
if(resp.ok) res(resp);
else rej(resp);
}).catch(err => rej(err));
} catch(err) {
rej(err);
}
});
}
}

View File

@ -1,13 +1,19 @@
export * from './array'; export * from './array';
export * from './aset'; export * from './aset';
export * from './download'; export * from './cache';
export * from './csv';
export * from './files';
export * from './emitter'; export * from './emitter';
export * from './errors'; export * from './errors';
export * from './http';
export * from './jwt';
export * from './logger'; export * from './logger';
export * from './math'; export * from './math';
export * from './misc'; export * from './misc';
export * from './objects'; export * from './objects';
export * from './path-events';
export * from './promise-progress'; export * from './promise-progress';
export * from './search';
export * from './string'; export * from './string';
export * from './time'; export * from './time';
export * from './xhr'; export * from './types';

15
src/jwt.ts Normal file
View 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('')));
}

View File

@ -1,4 +1,5 @@
import {TypedEmitter, TypedEvents} from './emitter'; import {TypedEmitter, TypedEvents} from './emitter';
import {JSONSanitize} from './objects.ts';
export const CliEffects = { export const CliEffects = {
CLEAR: "\x1b[0m", CLEAR: "\x1b[0m",
@ -64,49 +65,41 @@ export class Logger extends TypedEmitter<LoggerEvents> {
super(); super();
} }
private pad(text: any, length: number, char: string, end = false) { protected format(...text: any[]): string {
const t = text.toString();
const l = length - t.length;
if(l <= 0) return t;
const padding = Array(~~(l / char.length)).fill(char).join('');
return !end ? padding + t : t + padding;
}
private format(...text: string[]): string {
const now = new Date(); const now = new Date();
const timestamp = `${now.getFullYear()}-${now.getMonth() + 1}-${now.getDate()} ${this.pad(now.getHours().toString(), 2, '0')}:${this.pad(now.getMinutes().toString(), 2, '0')}:${this.pad(now.getSeconds().toString(), 2, '0')}.${this.pad(now.getMilliseconds().toString(), 3, '0', true)}`; const timestamp = `${now.getFullYear()}-${now.getMonth() + 1}-${now.getDate()} ${now.getHours().toString().padStart(2, '0')}:${now.getMinutes().toString().padStart(2, '0')}:${now.getSeconds().toString().padStart(2, '0')}.${now.getMilliseconds().toString().padEnd(3, '0')}`;
return `${timestamp}${this.namespace ? ` [${this.namespace}]` : ''} ${text.join(' ')}`; return `${timestamp}${this.namespace ? ` [${this.namespace}]` : ''} ${text.map(t => typeof t == 'string' ? t : JSONSanitize(t, 2)).join(' ')}`;
} }
debug(...args: string[]) { debug(...args: any[]) {
if(Logger.LOG_LEVEL < LOG_LEVEL.DEBUG) return; if(Logger.LOG_LEVEL < LOG_LEVEL.DEBUG) return;
const str = this.format(...args); const str = this.format(...args);
Logger.emit(LOG_LEVEL.DEBUG, str); Logger.emit(LOG_LEVEL.DEBUG, str);
console.debug(CliForeground.LIGHT_GREY + str + CliEffects.CLEAR); console.debug(CliForeground.LIGHT_GREY + str + CliEffects.CLEAR);
} }
log(...args: string[]) { log(...args: any[]) {
if(Logger.LOG_LEVEL < LOG_LEVEL.LOG) return; if(Logger.LOG_LEVEL < LOG_LEVEL.LOG) return;
const str = this.format(...args); const str = this.format(...args);
Logger.emit(LOG_LEVEL.LOG, str); Logger.emit(LOG_LEVEL.LOG, str);
console.log(CliEffects.CLEAR + str); console.log(CliEffects.CLEAR + str);
} }
info(...args: string[]) { info(...args: any[]) {
if(Logger.LOG_LEVEL < LOG_LEVEL.INFO) return; if(Logger.LOG_LEVEL < LOG_LEVEL.INFO) return;
const str = this.format(...args); const str = this.format(...args);
Logger.emit(LOG_LEVEL.INFO, str); Logger.emit(LOG_LEVEL.INFO, str);
console.info(CliForeground.BLUE + str + CliEffects.CLEAR); console.info(CliForeground.BLUE + str + CliEffects.CLEAR);
} }
warn(...args: string[]) { warn(...args: any[]) {
if(Logger.LOG_LEVEL < LOG_LEVEL.WARN) return; if(Logger.LOG_LEVEL < LOG_LEVEL.WARN) return;
const str = this.format(...args); const str = this.format(...args);
Logger.emit(LOG_LEVEL.WARN, str); Logger.emit(LOG_LEVEL.WARN, str);
console.warn(CliForeground.YELLOW + str + CliEffects.CLEAR); console.warn(CliForeground.YELLOW + str + CliEffects.CLEAR);
} }
error(...args: string[]) { error(...args: any[]) {
if(Logger.LOG_LEVEL < LOG_LEVEL.ERROR) return; if(Logger.LOG_LEVEL < LOG_LEVEL.ERROR) return;
const str = this.format(...args); const str = this.format(...args);
Logger.emit(LOG_LEVEL.ERROR, str); Logger.emit(LOG_LEVEL.ERROR, str);

View File

@ -1,17 +1,6 @@
import {PathEvent} from './path-events.ts';
import {md5} from './string'; 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 * Get profile image from Gravatar
* *
@ -24,41 +13,15 @@ export function gravatar(email: string, def='mp') {
return `https://www.gravatar.com/avatar/${md5(email)}?d=${def}`; return `https://www.gravatar.com/avatar/${md5(email)}?d=${def}`;
} }
/** Parts of a URL */ /**
export type ParsedUrl = { * Escape any regex special characters to avoid misinterpretation during search
protocol?: string, *
subdomain?: string, * @param {string} value String which should be escaped
domain: string, * @return {string} New escaped sequence
host: string, */
port?: number, export function escapeRegex(value: string) {
path?: string, return value.replace(/[.*+?^${}()|\[\]\\]/g, '\\$&');
query?: {[name: string]: string}
fragment?: string
} }
/** export type Listener = (event: PathEvent, ...args: any[]) => any;
* export type Unsubscribe = () => void;
* @param {string} url
* @returns {RegExpExecArray}
*/
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;
}

View File

@ -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) * Create a deep copy of an object (vs. a shallow copy of references)
* *
* Should be replaced by `structuredClone` once released. * Should be replaced by `structuredClone` once released.
*
* @param {T} value Object to copy * @param {T} value Object to copy
* @returns {T} Type * @returns {T} Type
*/ */
export function deepCopy<T>(value: T): T { 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 * @example
* ```ts * ```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 = {}) { export function flattenObj(obj: any, parent?: any, result: any = {}) {
if(typeof obj === "object" && !Array.isArray(obj)) { if(typeof obj === "object" && !Array.isArray(obj)) {
for(const key of Object.keys(obj)) { for(const key of Object.keys(obj)) {
const propName = parent ? parent + '.' + key : key; const propName = parent ? `${parent}.${key}` : key;
if(typeof obj[key] === 'object') { if(typeof obj[key] === 'object' && obj[key] != null && !Array.isArray(obj[key])) {
console.log(propName, );
flattenObj(obj[key], propName, result); flattenObj(obj[key], propName, result);
} else { } else {
result[propName] = obj[key]; 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 * Check that an object has the following values
* *
@ -141,6 +194,12 @@ export function isEqual(a: any, b: any): boolean {
return Object.keys(a).every(key => isEqual(a[key], b[key])); 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[]) { export function mixin(target: any, constructors: any[]) {
constructors.forEach(c => { constructors.forEach(c => {
Object.getOwnPropertyNames(c.prototype).forEach((name) => { Object.getOwnPropertyNames(c.prototype).forEach((name) => {
@ -154,13 +213,29 @@ export function mixin(target: any, constructors: any[]) {
}); });
} }
export function sanitizedJSON(obj: any, space?: number) { /**
let cache: any[] = []; * Parse JSON but return the original string if it fails
return JSON.parse(JSON.stringify(obj, (key, value) => { *
if (typeof value === 'object' && value !== null) { * @param {any} json JSON string to parse
if (cache.includes(value)) return; * @return {string | T} Object if successful, original string otherwise
cache.push(value); */
} export function JSONAttemptParse<T1, T2>(json: T2): T1 | T2 {
return value; try { return JSON.parse(<any>json); }
}, space)); catch { return json; }
}
/**
* 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);
} }

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

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

View File

@ -1,5 +1,25 @@
export type ProgressCallback = (progress: number) => any; 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> { export class PromiseProgress<T> extends Promise<T> {
private listeners: ProgressCallback[] = []; private listeners: ProgressCallback[] = [];
@ -15,12 +35,38 @@ export class PromiseProgress<T> extends Promise<T> {
super((resolve, reject) => executor( super((resolve, reject) => executor(
(value: T) => resolve(value), (value: T) => resolve(value),
(reason: any) => reject(reason), (reason: any) => reject(reason),
(progress: number) => this.progress = progress (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) { onProgress(callback: ProgressCallback) {
this.listeners.push(callback); this.listeners.push(callback);
return this; 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
View 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;
})
});
}

View File

@ -1,44 +1,55 @@
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 * String of all letters
*
*/ */
const LETTER_LIST = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'; export const LETTER_LIST = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
/** /**
* String of all numbers * String of all numbers
*
*/ */
const NUMBER_LIST = '0123456789'; export const NUMBER_LIST = '0123456789';
/** /**
* String of all symbols * String of all symbols
*/ */
const SYMBOL_LIST = '~`!@#$%^&*()_-+={[}]|\\:;"\'<,>.?/'; export const SYMBOL_LIST = '~`!@#$%^&*()_-+={[}]|\\:;"\'<,>.?/';
/** /**
* String of all letters, numbers & symbols * String of all letters, numbers & symbols
*/ */
const CHAR_LIST = LETTER_LIST + NUMBER_LIST + SYMBOL_LIST; export const CHAR_LIST = LETTER_LIST + LETTER_LIST.toLowerCase() + NUMBER_LIST + SYMBOL_LIST;
/**
* Convert number of bytes into a human-readable size
*
* @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) { export function formatPhoneNumber(number: string) {
const parts = /(\+?1)?.*?(\d{3}).*?(\d{3}).*?(\d{4})/g.exec(number); const parts = /(\+?1)?.*?(\d{3}).*?(\d{3}).*?(\d{4})/g.exec(number);
if(!parts) throw new Error(`Number cannot be parsed: ${number}`); if(!parts) throw new Error(`Number cannot be parsed: ${number}`);
return `${parts[1] ?? ''} (${parts[2]}) ${parts[3]}-${parts[4]}`.trim(); return `${parts[1] ? '+1' : ''} (${parts[2]}) ${parts[3]}-${parts[4]}`.trim();
} }
/** /**
* Insert a string into another string at a given position * Insert a string into another string at a given position
* *
* @example * @example
* ``` * ```js
* console.log(insertAt('Hello world!', ' glorious', 5); * console.log(insertAt('Hello world!', ' glorious', 5);
* // Output: Hello glorious world! * // Output: Hello glorious world!
* ``` * ```
@ -47,17 +58,42 @@ export function formatPhoneNumber(number: string) {
* @param {string} str - Value that will be injected to parent * @param {string} str - Value that will be injected to parent
* @param {number} index - Position to inject string at * @param {number} index - Position to inject string at
* @returns {string} - New string * @returns {string} - New string
* @deprecated use `strSplice()`
*/ */
export function insertAt(target: string, str: string, index: number): String { export function insertAt(target: string, str: string, index: number): String {
return `${target.slice(0, index)}${str}${target.slice(index + 1)}`; return `${target.slice(0, index)}${str}${target.slice(index + 1)}`;
} }
export function pad(text: any, length: number, char: string, start = true) { /**
const t = text.toString(); * Add padding to string
const l = length - t.length; *
if(l <= 0) return t; * @example
const padding = Array(~~(l / char.length)).fill(char).join(''); * ```js
return start ? padding + t : t + padding; * 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);
}
/**
* 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 +149,21 @@ export function randomStringBuilder(length: number, letters = false, numbers = f
}).join(''); }).join('');
} }
/**
* Splice a string together (Similar to Array.splice)
*
* @param {string} str String that will be modified
* @param {number} start Start index of splice
* @param {number} deleteCount Number of characters to remove in splice
* @param {string} insert Insert new string into splice
* @return {string} Returned spliced string
*/
export function strSplice(str: string, start: number, deleteCount: number, insert = '') {
const before = str.slice(0, start);
const after = str.slice(start + deleteCount);
return before + insert + after;
}
/** /**
* Find all substrings that match a given pattern. * Find all substrings that match a given pattern.
* *
@ -141,8 +192,51 @@ export function matchAll(value: string, regex: RegExp | string): RegExpExecArray
return ret; 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 * Create MD5 hash using native javascript
*
* @param d String to hash * @param d String to hash
* @returns {string} Hashed string * @returns {string} Hashed string
*/ */

View File

@ -1,3 +1,219 @@
/**
* Like setInterval but will adjust the timeout value to account for runtime
* @param {Function} cb Callback function that will be ran
* @param {number} ms Run function ever x seconds
* @return {() => void}
*/
export function adjustedInterval(cb: Function, ms: number) {
let cancel = false, timeout: any = null;
const p = async () => {
if (cancel) return;
const start = new Date().getTime();
await cb();
const end = new Date().getTime();
timeout = setTimeout(() => p(), ms - (end - start) || 1);
};
p();
return () => {
cancel = true;
if(timeout) clearTimeout(timeout);
}
}
/**
* Format date
*
* @param {Date | number | string} date Date or timestamp to convert to string
* @param {string} format How date string will be formatted, default: `YYYY-MM-DD H:mm A`
* @param tz Override timezone, can be either string or number
* @return {string} Formated date
*/
export function formatDate(date: Date | number | string, format = 'YYYY-MM-DD H:mm', tz?: string | number): string {
const timezones = [
['IDLW', -12],
['SST', -11],
['HST', -10],
['AKST', -9],
['PST', -8],
['MST', -7],
['CST', -6],
['EST', -5],
['AST', -4],
['BRT', -3],
['MAT', -2],
['AZOT', -1],
['UTC', 0],
['CET', 1],
['EET', 2],
['MSK', 3],
['AST', 4],
['PKT', 5],
['IST', 5.5],
['BST', 6],
['ICT', 7],
['CST', 8],
['JST', 9],
['AEST', 10],
['SBT', 11],
['FJT', 12],
['TOT', 13],
['LINT', 14]
];
function adjustTz(date: Date, gmt: number) {
const currentOffset = date.getTimezoneOffset();
const adjustedOffset = gmt * 60;
return new Date(date.getTime() + (adjustedOffset + currentOffset) * 60000);
}
function day(num: number): string {
switch(num) {
case(0): return 'Sunday';
case(1): return 'Monday';
case(2): return 'Tuesday';
case(3): return 'Wednesday';
case(4): return 'Thursday';
case(5): return 'Friday';
case(6): return 'Saturday';
default: return 'Unknown';
}
}
function doy(date: Date) {
const start = new Date(`${date.getFullYear()}-01-01 0:00:00`);
return Math.ceil((date.getTime() - start.getTime()) / (1000 * 60 * 60 * 24));
}
function month(num: number): string {
switch(num) {
case(0): return 'January';
case(1): return 'February';
case(2): return 'March';
case(3): return 'April';
case(4): return 'May';
case(5): return 'June';
case(6): return 'July';
case(7): return 'August';
case(8): return 'September';
case(9): return 'October';
case(10): return 'November';
case(11): return 'December';
default: return 'Unknown';
}
}
function suffix(num: number) {
let n = num.toString();
switch(n.at(-1)) {
case('1'): return num + 'st';
case('2'): return num + 'nd';
case('3'): return num + 'rd';
default: return num + 'th';
}
}
function tzOffset(offset: number) {
const hours = ~~(offset / 60);
const minutes = offset % 60;
return (offset > 0 ? '-' : '') + `${hours}:${minutes.toString().padStart(2, '0')}`;
}
if(typeof date == 'number' || typeof date == 'string') date = new Date(date);
// Handle timezones
let t!: [string, number];
if(tz == null) tz = -(date.getTimezoneOffset() / 60);
t = <any>timezones.find(t => isNaN(<any>tz) ? t[0] == tz : t[1] == tz);
if(!t) throw new Error(`Unknown timezone: ${tz}`);
date = adjustTz(date, t[1]);
return format
// Year
.replaceAll('YYYY', date.getFullYear().toString())
.replaceAll('YY', date.getFullYear().toString().slice(2))
// Month
.replaceAll('MMMM', month(date.getMonth()))
.replaceAll('MMM', month(date.getMonth()).slice(0, 3))
.replaceAll('MM', (date.getMonth() + 1).toString().padStart(2, '0'))
.replaceAll('M', (date.getMonth() + 1).toString())
// Day
.replaceAll('DDD', doy(date).toString())
.replaceAll('DD', date.getDate().toString().padStart(2, '0'))
.replaceAll('Do', suffix(date.getDate()))
.replaceAll('D', date.getDate().toString())
.replaceAll('dddd', day(date.getDay()))
.replaceAll('ddd', day(date.getDay()).slice(0, 2))
.replaceAll('dd', date.getDate().toString().padStart(2, '0'))
.replaceAll('d', date.getDay().toString())
// Hour
.replaceAll('HH', date.getHours().toString().padStart(2, '0'))
.replaceAll('H', date.getHours().toString())
.replaceAll('hh', (date.getHours() > 12 ? date.getHours() - 12 : date.getHours()).toString().padStart(2, '0'))
.replaceAll('h', (date.getHours() > 12 ? date.getHours() - 12 : date.getHours()).toString())
// Minute
.replaceAll('mm', date.getMinutes().toString().padStart(2, '0'))
.replaceAll('m', date.getMinutes().toString())
// Second
.replaceAll('ss', date.getSeconds().toString().padStart(2, '0'))
.replaceAll('s', date.getSeconds().toString())
// Millisecond
.replaceAll('SSS', date.getMilliseconds().toString().padEnd(3, '0'))
.replaceAll('SS', date.getMilliseconds().toString().slice(0, 1).padEnd(2, '0'))
.replaceAll('S', date.getMilliseconds().toString()[0])
// Period/Meridian (AM/PM)
.replaceAll('A', date.getHours() >= 12 ? 'PM' : 'AM')
.replaceAll('a', date.getHours() >= 12 ? 'pm' : 'am')
// Timezone
.replaceAll('ZZ', tzOffset(t[1] * 60).replace(':', ''))
.replaceAll('Z', tzOffset(t[1] * 60))
.replaceAll('z', typeof tz == 'string' ? tz : (<any>t)[0]);
}
/**
* Run a function immediately & repeat every x ms
*
* @param {() => any} fn Callback function
* @param {number} interval Repeat in ms
* @return {number} Clear Interval ID
*/
export function instantInterval(fn: () => any, interval: number) {
fn();
return setInterval(fn, interval);
}
/**
* 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 * Calculate the number of milliseconds until date/time
* *
@ -7,34 +223,3 @@
export function timeUntil(date: Date | number): number { export function timeUntil(date: Date | number): number {
return (date instanceof Date ? date.getTime() : date) - (new Date()).getTime(); 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
View 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>;
}

View File

@ -1,90 +0,0 @@
import {clean} from './objects';
export type Interceptor = (request: Response, next: () => void) => void;
export type RequestOptions = {
url?: string;
fragment?: string;
query?: {key: string, value: string}[] | {[key: string]: string};
method?: 'GET' | 'POST' | 'PATCH' | 'DELETE';
body?: any;
headers?: {[key: string | symbol]: string | null | undefined};
skipConverting?: boolean;
[key: string]: any;
}
export type XhrOptions = {
headers?: {[key: string | symbol]: string | null | undefined};
interceptors?: Interceptor[];
url?: string;
}
export class XHR {
private static interceptors: {[key: string]: Interceptor} = {};
static headers: {[key: string]: string | null | undefined} = {};
private interceptors: {[key: string]: Interceptor} = {}
headers: {[key: string]: string | null | undefined} = {}
constructor(public readonly opts: XhrOptions = {}) {
this.headers = opts.headers || {};
if(opts.interceptors) {
opts.interceptors.forEach(i => XHR.addInterceptor(i));
}
}
static addInterceptor(fn: Interceptor): () => void {
const key = Object.keys(XHR.interceptors).length.toString();
XHR.interceptors[key] = fn;
return () => { XHR.interceptors[key] = <any>null; }
}
addInterceptor(fn: Interceptor): () => void {
const key = Object.keys(this.interceptors).length.toString();
this.interceptors[key] = fn;
return () => { this.interceptors[key] = <any>null; }
}
async request<T>(opts: RequestOptions = {}): Promise<T> {
if(!this.opts.url && !opts.url) throw new Error('URL needs to be set');
let url = (opts.url?.startsWith('http') ? opts.url : (this.opts.url || '') + (opts.url || '')).replace(/([^:]\/)\/+/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 && !(opts.body instanceof FormData)) ? 'application/json' : undefined,
...XHR.headers,
...this.headers,
...opts.headers
});
// Send request
return fetch(url, {
headers,
method: opts.method || (opts.body ? 'POST' : 'GET'),
body: (headers['Content-Type']?.startsWith('application/json') && opts.body) ? JSON.stringify(opts.body) : opts.body
}).then(async resp => {
for(let fn of [...Object.values(XHR.interceptors), ...Object.values(this.interceptors)]) {
await new Promise<void>(res => fn(resp, () => res()));
}
const decode = async () => {
if(!opts.skipConverting && resp.headers.get('Content-Type')?.startsWith('application/json')) return await resp.json();
if(!opts.skipConverting && resp.headers.get('Content-Type')?.startsWith('text/plain')) return await <any>resp.text();
return resp;
}
const payload = await decode();
if(resp.ok) return payload;
const text = resp.statusText || (typeof payload == 'string' ? payload : null);
throw (text ? new Error(text) : payload);
});
}
}

View File

@ -1,4 +1,4 @@
import {sleep, urlParser} from '../src'; import {sleep, parseUrl} from '../src';
describe('Miscellanies Utilities', () => { describe('Miscellanies Utilities', () => {
describe('sleep', () => { describe('sleep', () => {
@ -12,7 +12,7 @@ describe('Miscellanies Utilities', () => {
describe('urlParser', () => { describe('urlParser', () => {
test('localhost w/ port', () => { 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.protocol).toStrictEqual('http');
expect(parsed.host).toStrictEqual('localhost:4200'); expect(parsed.host).toStrictEqual('localhost:4200');
expect(parsed.domain).toStrictEqual('localhost'); expect(parsed.domain).toStrictEqual('localhost');
@ -23,7 +23,7 @@ describe('Miscellanies Utilities', () => {
}); });
test('advanced URL', () => { 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.protocol).toStrictEqual('https');
expect(parsed.host).toStrictEqual('sub.domain.example.com'); expect(parsed.host).toStrictEqual('sub.domain.example.com');
expect(parsed.domain).toStrictEqual('example.com'); expect(parsed.domain).toStrictEqual('example.com');

View File

@ -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', () => { describe('dotNotation', () => {
test('no object or properties', () => { test('no object or properties', () => {
expect(dotNotation(undefined, 'z')).toStrictEqual(undefined); expect(dotNotation(undefined, 'z')).toStrictEqual(undefined);

View File

@ -8,12 +8,12 @@ export default defineConfig({
entry: resolve(process.cwd(), 'src/index.ts'), entry: resolve(process.cwd(), 'src/index.ts'),
name: 'utils', name: 'utils',
fileName: (module, entryName) => { fileName: (module, entryName) => {
if(module == 'es') return 'utils.mjs'; if(module == 'es') return 'index.mjs';
if(module == 'umd') return 'utils.cjs'; if(module == 'umd') return 'index.cjs';
} }
}, },
emptyOutDir: true, emptyOutDir: true,
minify: true, minify: false,
sourcemap: true sourcemap: true
}, },
plugins: [dts()], plugins: [dts()],