Compare commits

...

35 Commits

Author SHA1 Message Date
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
3f85c9cf7d Updated package.json to include types file
All checks were successful
Build / Build NPM Project (push) Successful in 41s
Build / Tag Version (push) Successful in 5s
2024-06-17 10:23:48 -04:00
1eff60e7dd Fixed build
All checks were successful
Build / Build NPM Project (push) Successful in 22s
Build / Tag Version (push) Successful in 5s
2024-06-16 08:36:45 -04:00
1d9ad2ef63 Fixed module exports?
All checks were successful
Build / Build NPM Project (push) Successful in 38s
Build / Tag Version (push) Successful in 5s
Build / Publish (push) Successful in 7s
2024-06-16 08:29:49 -04:00
973a884b3e Added query & fragment to xhr
All checks were successful
Build / Build NPM Project (push) Successful in 38s
Build / Tag Version (push) Successful in 5s
Build / Publish (push) Successful in 7s
2024-06-15 22:29:37 -04:00
6f60f8bd94 Changed XHR error handling
All checks were successful
Build / Build NPM Project (push) Successful in 1m13s
Build / Tag Version (push) Successful in 16s
Build / Publish (push) Successful in 22s
2024-05-31 13:42:28 -04:00
07606cd996 Removed custom errors from xhr helper
All checks were successful
Build / Build NPM Project (push) Successful in 1m14s
Build / Tag Version (push) Successful in 16s
Build / Publish (push) Successful in 23s
2024-05-31 12:37:01 -04:00
14 changed files with 382 additions and 214 deletions

View File

@ -9,39 +9,28 @@ jobs:
build:
name: Build NPM Project
runs-on: ubuntu-latest
container:
image: node
volumes:
- '/mnt/swarm/gitea/runner/cache:/cache'
container: node:20-alpine
steps:
- name: Clone Repository
uses: ztimson/actions/clone@develop
- name: Restore node_modules
uses: ztimson/actions/cache/restore@develop
with:
key: node_modules
- name: Install Dependencies
run: npm i
- name: Build Project
run: npm run build
- name: Install & Build
run: |
npm i
npm run build
- name: Test
run: npm run test:coverage
- name: Cache node_modules
uses: ztimson/actions/cache@develop
with:
key: node_modules
pattern: node_modules
- name: Upload to Registry
uses: ztimson/actions/npm/publish@develop
- name: Cache Artifacts
uses: ztimson/actions/cache@develop
- name: Upload to NPM
uses: ztimson/actions/npm/publish@develop
with:
key: dist
pattern: dist
owner: ztimson
registry: https://registry.npmjs.org/
token: ${{secrets.NPM_TOKEN}}
tag:
name: Tag Version
needs: build
@ -59,31 +48,3 @@ jobs:
uses: ztimson/actions/tag@develop
with:
tag: ${{env.VERSION}}
publish:
name: Publish
needs: build
if: ${{github.ref_name}} == 'release'
runs-on: ubuntu-latest
container:
image: node
volumes:
- '/mnt/swarm/gitea/runner/cache:/cache'
steps:
- name: Clone Repository
uses: ztimson/actions/clone@develop
- name: Restore Artifacts
uses: ztimson/actions/cache/restore@develop
with:
key: dist
- name: Upload to Registry
uses: ztimson/actions/npm/publish@develop
- name: Upload to NPM
uses: ztimson/actions/npm/publish@develop
with:
owner: ztimson
registry: https://registry.npmjs.org/
token: ${{secrets.NPM_TOKEN}}

4
package-lock.json generated
View File

@ -1,12 +1,12 @@
{
"name": "@ztimson/utils",
"version": "0.4.0",
"version": "0.15.1",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "@ztimson/utils",
"version": "0.4.0",
"version": "0.15.1",
"license": "MIT",
"devDependencies": {
"@types/jest": "^29.5.12",

View File

@ -1,6 +1,6 @@
{
"name": "@ztimson/utils",
"version": "0.10.1",
"version": "0.15.2",
"description": "Utility library",
"author": "Zak Timson",
"license": "MIT",
@ -9,9 +9,16 @@
"type": "git",
"url": "https://git.zakscode.com/ztimson/js-utilities"
},
"main": "./dist/utils.cjs",
"module": "./dist/utils.mjs",
"main": "./dist/index.cjs",
"module": "./dist/index.mjs",
"types": "./dist/index.d.ts",
"exports": {
".": {
"import": "./dist/index.mjs",
"require": "./dist/index.cjs",
"types": "./dist/index.d.ts"
}
},
"scripts": {
"build": "npx tsc && npx vite build",
"test": "npx jest",

View File

@ -1,57 +1,108 @@
/**
* An array which functions as a set. It guarantees unique elements
* and provides set functions for comparisons
*/
export class ASet<T> extends Array {
/** Number of elements in set */
get size() {
return this.length;
}
/**
* Array to create set from, duplicate values will be removed
* @param {T[]} elements Elements which will be added to set
*/
constructor(elements: T[] = []) {
super();
if(!!elements?.['forEach'])
elements.forEach(el => this.add(el));
}
/**
* Add single element to set if unique
* @param {T} el Element to add
*/
add(el: T) {
if(!this.has(el)) this.push(el);
}
/**
* Delete element from set
* @param {T} el Element that will be deleted
*/
delete(el: T) {
const index = this.indexOf(el);
if(index != -1) this.slice(index, 1);
}
/**
* Create list of elements this set has which the comparison set does not
* @param {ASet<T>} set Set to compare against
* @return {ASet<T>} Different elements
*/
difference(set: ASet<T>) {
return new ASet<T>(this.reduce((acc, el) => {
if(!set.has(el)) acc.push(el);
return acc;
}, []));
return new ASet<T>(this.filter(el => !set.has(el)));
}
/**
* Check if set includes element
* @param {T} el Element to look for
* @return {boolean} True if element was found, false otherwise
*/
has(el: T) {
return this.indexOf(el) != -1;
}
/**
* 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.reduce((acc, el) => {
if(set.has(el)) acc.push(el);
return acc;
}, []));
return new ASet<T>(this.filter(el => set.has(el)));
}
/**
* Check if this set has no elements in common with the comparison set
* @param {ASet<T>} set Set to compare against
* @return {boolean} True if nothing in common, false otherwise
*/
isDisjointFrom(set: ASet<T>) {
return this.intersection(set).size == 0;
}
/**
* Check if all elements in this set are included in the comparison set
* @param {ASet<T>} set Set to compare against
* @return {boolean} True if all elements are included, false otherwise
*/
isSubsetOf(set: ASet<T>) {
return this.findIndex(el => !set.has(el)) == -1;
}
/**
* Check if all elements from comparison set are included in this set
* @param {ASet<T>} set Set to compare against
* @return {boolean} True if all elements are included, false otherwise
*/
isSuperset(set: ASet<T>) {
return set.findIndex(el => !this.has(el)) == -1;
}
/**
* Create list of elements that are only in one set but not both (XOR)
* @param {ASet<T>} set Set to compare against
* @return {ASet<T>} New set of unique elements
*/
symmetricDifference(set: ASet<T>) {
return new ASet([...this.difference(set), ...set.difference(this)]);
}
/**
* Create joined list of elements included in this & the comparison set
* @param {ASet<T>} set Set join
* @return {ASet<T>} New set of both previous sets combined
*/
union(set: ASet<T> | Array<T>) {
return new ASet([...this, ...set]);
}

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);
}

56
src/files.ts Normal file
View File

@ -0,0 +1,56 @@
import {deepCopy, JSONAttemptParse} from './objects.ts';
import {PromiseProgress} from './promise-progress';
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);
}
export function downloadBlob(blob: Blob, name: string) {
const url = URL.createObjectURL(blob);
download(url, name);
URL.revokeObjectURL(url);
}
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();
});
}
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);
});
}

121
src/http.ts Normal file
View File

@ -0,0 +1,121 @@
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' | '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) => {
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);
})
});
}
}

View File

@ -1,8 +1,9 @@
export * from './array';
export * from './aset';
export * from './download';
export * from './files';
export * from './emitter';
export * from './errors';
export * from './http';
export * from './logger';
export * from './math';
export * from './misc';
@ -10,4 +11,3 @@ export * from './objects';
export * from './promise-progress';
export * from './string';
export * from './time';
export * from './xhr';

View File

@ -1,17 +1,5 @@
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
*

View File

@ -35,6 +35,27 @@ export function deepCopy<T>(value: T): T {
return JSON.parse(JSON.stringify(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;
}
/**
* Get/set a property of an object using dot notation
*
@ -98,6 +119,17 @@ 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
*
@ -154,7 +186,12 @@ export function mixin(target: any, constructors: any[]) {
});
}
export function sanitizedJSON(obj: any, space?: number) {
export function JSONAttemptParse<T>(json: string): T | string {
try { return JSON.parse(json); }
catch { return json; }
}
export function JSONSanitized(obj: any, space?: number) {
let cache: any[] = [];
return JSON.parse(JSON.stringify(obj, (key, value) => {
if (typeof value === 'object' && value !== null) {
@ -164,3 +201,15 @@ export function sanitizedJSON(obj: any, space?: number) {
return value;
}, space));
}
/**
* Convert object into URL encoded string
*
* @param {any} data - data to convert
* @returns {string} - Encoded form data
*/
export function urlEncode(data: any): string {
return Object.entries(data).map(([key, value]) =>
encodeURIComponent(key) + '=' + encodeURIComponent(<any>value)
).join('&');
}

View File

@ -15,12 +15,38 @@ export class PromiseProgress<T> extends Promise<T> {
super((resolve, reject) => executor(
(value: T) => resolve(value),
(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) {
this.listeners.push(callback);
return this;
}
then(res?: (v: T) => any, rej?: (err: any) => any): PromiseProgress<any> {
const resp = super.then(res, rej);
return this.from(resp);
}
catch(rej?: (err: any) => any): PromiseProgress<any> {
return this.from(super.catch(rej));
}
finally(res?: () => any): PromiseProgress<any> {
return this.from(super.finally(res));
}
}

View File

@ -1,32 +1,3 @@
/**
* Calculate the number of milliseconds until date/time
*
* @param {Date | number} date - Target
* @returns {number} - Number of milliseconds until target
*/
export function timeUntil(date: Date | number): number {
return (date instanceof Date ? date.getTime() : date) - (new Date()).getTime();
}
/**
* Use in conjunction with `await` to pause an async script
*
* @example
* ```ts
* async () => {
* ...
* await sleep(1000) // Pause for 1 second
* ...
* }
* ```
*
* @param {number} ms - Time to pause for in milliseconds
* @returns {Promise<unknown>} - Resolves promise when it's time to resume
*/
export function sleep(ms: number) {
return new Promise(res => setTimeout(res, ms));
}
export function formatDate(date: Date | number | string) {
const d = date instanceof Date ? date : new Date(date);
return new Intl.DateTimeFormat("en-us", {
@ -38,3 +9,44 @@ export function formatDate(date: Date | number | string) {
hour12: true
}).format(d);
}
/**
* 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 sleepUntil(() => loading); // Won't continue until loading flag is false
* ```
* @param {() => boolean} fn Return true to continue
* @param {number} checkInterval Run function ever x milliseconds
* @return {Promise<void>} Callback when sleep is over
*/
export async function sleepUntil(fn : () => boolean, checkInterval=100): Promise<void> {
while(fn()) await sleep(checkInterval);
}
/**
* Calculate the number of milliseconds until date/time
*
* @param {Date | number} date - Target
* @returns {number} - Number of milliseconds until target
*/
export function timeUntil(date: Date | number): number {
return (date instanceof Date ? date.getTime() : date) - (new Date()).getTime();
}

View File

@ -1,95 +0,0 @@
import {
BadRequestError,
CustomError,
ForbiddenError,
InternalServerError,
NotFoundError,
UnauthorizedError
} from './errors.ts';
import {clean} from './objects';
export type Interceptor = (request: Response, next: () => void) => void;
export type RequestOptions = {
url?: 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');
const url = (opts.url?.startsWith('http') ? opts.url : (this.opts.url || '') + (opts.url || '')).replace(/([^:]\/)\/+/g, '$1');
// 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()));
}
if(!resp.ok) throw new Error(resp.statusText);
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;
});
}
}
XHR.addInterceptor((resp: Response, next: () => void) => {
const getErr = (e: any) => e.error?.message || e.reason?.message || e.message || e.statusText || e.toString();
if(resp.status == 200) return next();
if(resp.status == 400) throw new BadRequestError(getErr(resp));
if(resp.status == 401) throw new UnauthorizedError(getErr(resp));
if(resp.status == 403) throw new ForbiddenError(getErr(resp));
if(resp.status == 404) throw new NotFoundError(getErr(resp));
if(resp.status == 500) throw new InternalServerError(getErr(resp));
throw new CustomError(getErr(resp), resp.status);
});

View File

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