Compare commits

...

10 Commits

Author SHA1 Message Date
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
8 changed files with 189 additions and 120 deletions

View File

@ -9,34 +9,19 @@ 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

View File

@ -1,6 +1,6 @@
{
"name": "@ztimson/utils",
"version": "0.12.0",
"version": "0.13.1",
"description": "Utility library",
"author": "Zak Timson",
"license": "MIT",

122
src/http.ts Normal file
View File

@ -0,0 +1,122 @@
import {clean} from './objects';
import {PromiseProgress} from './promise-progress.ts';
export type DecodedResponse<T> = Response & {data?: T}
export type HttpInterceptor = (response: Response, next: () => void) => void;
export type HttpRequestOptions = {
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};
[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.json);
// Send request
return new PromiseProgress((res, rej, prog) => {
fetch(url, {
headers,
method: opts.method || (opts.body ? 'POST' : 'GET'),
body: opts.body
}).then(async (resp: DecodedResponse<T>) => {
console.log('done!');
for(let fn of [...Object.values(Http.interceptors), ...Object.values(this.interceptors)]) {
await new Promise<void>(res => fn(resp, () => res()));
}
if(!resp.ok) rej(resp);
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(({done, value}) => {
if(done) return controller.close();
loaded += value.byteLength;
prog(loaded / total);
controller.enqueue(value);
push();
}).catch(error => {
controller.error(error);
});
}
push();
}
});
const data = new Response(stream);
const content = resp.headers.get('Content-Type')?.toLowerCase();
if(content?.includes('json')) resp.data = <T>await data.json();
else if(content?.includes('text')) resp.data = <T>await data.text();
else if(content?.includes('form')) resp.data = <T>await data.formData();
else if(content?.includes('application')) resp.data = <T>await data.blob();
res(resp);
})
});
}
}

View File

@ -3,6 +3,7 @@ export * from './aset';
export * from './download';
export * from './emitter';
export * from './errors';
export * from './http';
export * from './logger';
export * from './math';
export * from './misc';
@ -10,4 +11,4 @@ export * from './objects';
export * from './promise-progress';
export * from './string';
export * from './time';
export * from './xhr';
export * from './upload';

View File

@ -42,17 +42,17 @@ export function deepCopy<T>(value: T): T {
* @param sources Objects that will copied into target
* @return {any} The des
*/
function deepMerge<T>(target: any, ...sources: any[]): T {
for(const source of sources) {
for(const key in source) {
if(source[key] && typeof source[key] == 'object' && !Array.isArray(source[key])) {
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], source[key]);
deepMerge(target[key], s[key]);
} else {
target[key] = source[key];
target[key] = s[key];
}
}
}
});
return target;
}

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

25
src/upload.ts Normal file
View File

@ -0,0 +1,25 @@
import {PromiseProgress} from './promise-progress.ts';
export type UploadOptions = {
url: string;
file: File;
headers?: {[key: string]: string};
withCredentials?: boolean;
}
export function uploadWithProgress(options: UploadOptions) {
return new PromiseProgress((res, rej, prog) => {
const xhr = new XMLHttpRequest();
const formData = new FormData();
formData.append('file', options.file);
xhr.withCredentials = !!options.withCredentials
Object.entries(options.headers || {}).forEach(([key, value]) => xhr.setRequestHeader(key, value));
xhr.upload.addEventListener('progress', (event) => event.lengthComputable ? prog(event.loaded / event.total) : null);
xhr.upload.addEventListener('load', (resp) => res(resp));
xhr.upload.addEventListener('error', (err) => rej(err));
xhr.open('POST', options.url);
xhr.send(formData);
});
}

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