@jeniex/utils 1.1.3 → 1.2.0

package/browser/index.cjs

@@ -54,6 +54,11 @@ function asserted(object) {
     }
     return object;
 }
+function stringOrThrow(value) {
+    if (!isString(value)) {
+        throw new Error('Expected a string.');
+    }
+}
 function isTruthy(object) {
     return Boolean(object) === true;
 }
@@ -468,6 +473,114 @@ function customizeConsole(debug = false) {
     };
 }
 
+function createRequest(transport, url, options) {
+    const getResponse = async () => {
+        return transport(url, options);
+    };
+    return {
+        response: async () => {
+            return getResponse();
+        },
+        blob: async () => {
+            const response = await getResponse();
+            return response.blob();
+        },
+        buffer: async () => {
+            const response = await getResponse();
+            return response.arrayBuffer();
+        },
+        json: async () => {
+            const response = await getResponse();
+            return response.json();
+        },
+        text: async () => {
+            const response = await getResponse();
+            return response.text();
+        },
+        document: async () => {
+            const response = await getResponse();
+            const responseText = await response.text();
+            const parser = new DOMParser();
+            return parser.parseFromString(responseText, 'text/html');
+        },
+        multi: async (types) => {
+            const response = await getResponse();
+            const responses = { response };
+            if (types.includes('blob')) {
+                responses.blob = await response.clone().blob();
+            }
+            if (types.includes('buffer')) {
+                responses.buffer = await response.clone().arrayBuffer();
+            }
+            if (types.includes('json')) {
+                responses.json = (await response.clone().json());
+            }
+            if (types.includes('text')) {
+                responses.text = await response.clone().text();
+            }
+            if (types.includes('document')) {
+                const responseText = await response.clone().text();
+                const parser = new DOMParser();
+                responses.document = parser.parseFromString(responseText, 'text/html');
+            }
+            return responses;
+        },
+    };
+}
+
+function isFileURL(url) {
+    return url.startsWith('file:///');
+}
+
+async function fetchTransport(url, options) {
+    const response = await fetch(url, options);
+    if (!response.ok && !isFileURL(response.url)) {
+        throw new Error(`Request to ${response.url} ended with ${response.status} status.`);
+    }
+    return response;
+}
+
+function rq(url, options) {
+    return createRequest(fetchTransport, url, options);
+}
+
+async function gmTransport(url, options) {
+    const { method, anonymous, headers, body, timeOut, onProgress } = options ?? {};
+    return new Promise((resolve, reject) => {
+        GM.xmlHttpRequest({
+            url,
+            method: method ?? 'GET',
+            headers,
+            /** Note: To manually set the 'cookie' header, you have to set 'anonymous' to true. */
+            anonymous,
+            data: body,
+            responseType: 'blob',
+            timeout: timeOut,
+            onprogress: onProgress,
+            onload({ response, statusText, status, finalUrl }) {
+                const ok = status >= 200 && status < 300;
+                if (!ok && !isFileURL(finalUrl)) {
+                    reject(new Error(`Request to ${url} ended with ${status} status.`));
+                    return;
+                }
+                const properResponse = new Response(response, {
+                    statusText,
+                    status: isFileURL(finalUrl) ? 200 : status,
+                });
+                Object.defineProperty(properResponse, 'url', { value: finalUrl });
+                resolve(properResponse);
+            },
+            onerror({ status }) {
+                reject(new Error(`Request to ${url} ended with ${status} status.`));
+            },
+        });
+    });
+}
+
+function rx(url, options) {
+    return createRequest(gmTransport, url, options);
+}
+
 exports.$ = $;
 exports.$$ = $$;
 exports.addStyle = addStyle;
@@ -501,9 +614,13 @@ exports.pageLoad = pageLoad;
 exports.prompt = prompt;
 exports.remove = remove;
 exports.removeSearchParams = removeSearchParams;
+exports.rq = rq;
+exports.rqc = createRequest;
+exports.rx = rx;
 exports.saveFile = saveFile;
 exports.scriptName = scriptName;
 exports.setSearchParam = setSearchParam;
 exports.sleep = sleep;
+exports.stringOrThrow = stringOrThrow;
 exports.tabURL = tabURL;
 exports.toString = toString;

package/browser/index.d.ts

@@ -17,6 +17,7 @@ declare function noop(): void;
 declare function toString(object: unknown): string;
 
 declare function asserted<T>(object: T | null | undefined): T;
+declare function stringOrThrow(value: unknown): asserts value is string;
 declare function isTruthy<T>(object: T): object is Exclude<T, '' | 0 | false | null | undefined>;
 declare function isFalsy(object: unknown): object is '' | 0 | false | null | undefined;
 declare function isNullish(object: unknown): object is null | undefined;
@@ -59,9 +60,9 @@ declare function alert(message?: string): void;
 declare function confirm(message: string): boolean;
 declare function prompt(message: string, _default?: string): string | null;
 
-type Method = 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE';
+type Method$1 = 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE';
 interface FishXOptions {
-    method?: Method;
+    method?: Method$1;
     anonymous?: boolean;
     headers?: Record<string, string>;
     body?: Blob | FormData | string;
@@ -167,4 +168,39 @@ interface CustomizedConsole {
 
 declare function customizeConsole(debug?: boolean): CustomizedConsole;
 
-export { $, $$, Flag, Fn, Nullable, Prettify, addStyle, alert, asserted, capitalize, checkVPN, checkVPNRandomly, confirm, customizeConsole, fish, fishResponse, fishX, fishXResponse, getOptions, getSearchParam, imageLoad, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, noop, padZeros, pageLoad, prompt, remove, removeSearchParams, saveFile, scriptName, setSearchParam, sleep, tabURL, toString };
+type Method = 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE';
+interface RxOptions {
+    method?: Method;
+    anonymous?: boolean;
+    headers?: Record<string, string>;
+    body?: Blob | FormData | string;
+    timeOut?: number;
+    onProgress?: (response: VMScriptResponseObject<Blob>) => Promise<void> | void;
+}
+interface RqRequest {
+    response: () => Promise<Response>;
+    blob: () => Promise<Blob>;
+    buffer: () => Promise<ArrayBuffer>;
+    json: <T = unknown>() => Promise<T>;
+    text: () => Promise<string>;
+    document: () => Promise<Document>;
+    multi: <T = unknown>(types: ResponseType[]) => Promise<Responses<T>>;
+}
+type Transport<TOptions = unknown> = (url: string, options?: TOptions) => Promise<Response>;
+type ResponseType = 'blob' | 'buffer' | 'document' | 'json' | 'text';
+interface Responses<T> {
+    response?: Response;
+    blob?: Blob;
+    buffer?: ArrayBuffer;
+    json?: T;
+    text?: string;
+    document?: Document;
+}
+
+declare function rq(url: string, options?: RequestInit): RqRequest;
+
+declare function rx(url: string, options?: RxOptions): RqRequest;
+
+declare function createRequest<TOptions>(transport: Transport<TOptions>, url: string, options?: TOptions): RqRequest;
+
+export { $, $$, Flag, Fn, Nullable, Prettify, addStyle, alert, asserted, capitalize, checkVPN, checkVPNRandomly, confirm, customizeConsole, fish, fishResponse, fishX, fishXResponse, getOptions, getSearchParam, imageLoad, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, noop, padZeros, pageLoad, prompt, remove, removeSearchParams, rq, createRequest as rqc, rx, saveFile, scriptName, setSearchParam, sleep, stringOrThrow, tabURL, toString };

package/browser/index.js

@@ -52,6 +52,11 @@ function asserted(object) {
     }
     return object;
 }
+function stringOrThrow(value) {
+    if (!isString(value)) {
+        throw new Error('Expected a string.');
+    }
+}
 function isTruthy(object) {
     return Boolean(object) === true;
 }
@@ -466,4 +471,112 @@ function customizeConsole(debug = false) {
     };
 }
 
-export { $, $$, addStyle, alert, asserted, capitalize, checkVPN, checkVPNRandomly, confirm, customizeConsole, fish, fishResponse, fishX, fishXResponse, getOptions, getSearchParam, imageLoad, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, noop, padZeros, pageLoad, prompt, remove, removeSearchParams, saveFile, scriptName, setSearchParam, sleep, tabURL, toString };
+function createRequest(transport, url, options) {
+    const getResponse = async () => {
+        return transport(url, options);
+    };
+    return {
+        response: async () => {
+            return getResponse();
+        },
+        blob: async () => {
+            const response = await getResponse();
+            return response.blob();
+        },
+        buffer: async () => {
+            const response = await getResponse();
+            return response.arrayBuffer();
+        },
+        json: async () => {
+            const response = await getResponse();
+            return response.json();
+        },
+        text: async () => {
+            const response = await getResponse();
+            return response.text();
+        },
+        document: async () => {
+            const response = await getResponse();
+            const responseText = await response.text();
+            const parser = new DOMParser();
+            return parser.parseFromString(responseText, 'text/html');
+        },
+        multi: async (types) => {
+            const response = await getResponse();
+            const responses = { response };
+            if (types.includes('blob')) {
+                responses.blob = await response.clone().blob();
+            }
+            if (types.includes('buffer')) {
+                responses.buffer = await response.clone().arrayBuffer();
+            }
+            if (types.includes('json')) {
+                responses.json = (await response.clone().json());
+            }
+            if (types.includes('text')) {
+                responses.text = await response.clone().text();
+            }
+            if (types.includes('document')) {
+                const responseText = await response.clone().text();
+                const parser = new DOMParser();
+                responses.document = parser.parseFromString(responseText, 'text/html');
+            }
+            return responses;
+        },
+    };
+}
+
+function isFileURL(url) {
+    return url.startsWith('file:///');
+}
+
+async function fetchTransport(url, options) {
+    const response = await fetch(url, options);
+    if (!response.ok && !isFileURL(response.url)) {
+        throw new Error(`Request to ${response.url} ended with ${response.status} status.`);
+    }
+    return response;
+}
+
+function rq(url, options) {
+    return createRequest(fetchTransport, url, options);
+}
+
+async function gmTransport(url, options) {
+    const { method, anonymous, headers, body, timeOut, onProgress } = options ?? {};
+    return new Promise((resolve, reject) => {
+        GM.xmlHttpRequest({
+            url,
+            method: method ?? 'GET',
+            headers,
+            /** Note: To manually set the 'cookie' header, you have to set 'anonymous' to true. */
+            anonymous,
+            data: body,
+            responseType: 'blob',
+            timeout: timeOut,
+            onprogress: onProgress,
+            onload({ response, statusText, status, finalUrl }) {
+                const ok = status >= 200 && status < 300;
+                if (!ok && !isFileURL(finalUrl)) {
+                    reject(new Error(`Request to ${url} ended with ${status} status.`));
+                    return;
+                }
+                const properResponse = new Response(response, {
+                    statusText,
+                    status: isFileURL(finalUrl) ? 200 : status,
+                });
+                Object.defineProperty(properResponse, 'url', { value: finalUrl });
+                resolve(properResponse);
+            },
+            onerror({ status }) {
+                reject(new Error(`Request to ${url} ended with ${status} status.`));
+            },
+        });
+    });
+}
+
+function rx(url, options) {
+    return createRequest(gmTransport, url, options);
+}
+
+export { $, $$, addStyle, alert, asserted, capitalize, checkVPN, checkVPNRandomly, confirm, customizeConsole, fish, fishResponse, fishX, fishXResponse, getOptions, getSearchParam, imageLoad, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, noop, padZeros, pageLoad, prompt, remove, removeSearchParams, rq, createRequest as rqc, rx, saveFile, scriptName, setSearchParam, sleep, stringOrThrow, tabURL, toString };

package/node/index.cjs

@@ -58,6 +58,11 @@ function asserted(object) {
     }
     return object;
 }
+function stringOrThrow(value) {
+    if (!isString(value)) {
+        throw new Error('Expected a string.');
+    }
+}
 function isTruthy(object) {
     return Boolean(object) === true;
 }
@@ -239,6 +244,77 @@ async function readJSON(filePath, withComments = false) {
     return JSON.parse(stringJSON);
 }
 
+function createRequest(transport, url, options) {
+    const getResponse = async () => {
+        return transport(url, options);
+    };
+    return {
+        response: async () => {
+            return getResponse();
+        },
+        blob: async () => {
+            const response = await getResponse();
+            return response.blob();
+        },
+        buffer: async () => {
+            const response = await getResponse();
+            return response.arrayBuffer();
+        },
+        json: async () => {
+            const response = await getResponse();
+            return response.json();
+        },
+        text: async () => {
+            const response = await getResponse();
+            return response.text();
+        },
+        document: async () => {
+            const response = await getResponse();
+            const responseText = await response.text();
+            const parser = new DOMParser();
+            return parser.parseFromString(responseText, 'text/html');
+        },
+        multi: async (types) => {
+            const response = await getResponse();
+            const responses = { response };
+            if (types.includes('blob')) {
+                responses.blob = await response.clone().blob();
+            }
+            if (types.includes('buffer')) {
+                responses.buffer = await response.clone().arrayBuffer();
+            }
+            if (types.includes('json')) {
+                responses.json = (await response.clone().json());
+            }
+            if (types.includes('text')) {
+                responses.text = await response.clone().text();
+            }
+            if (types.includes('document')) {
+                const responseText = await response.clone().text();
+                const parser = new DOMParser();
+                responses.document = parser.parseFromString(responseText, 'text/html');
+            }
+            return responses;
+        },
+    };
+}
+
+function isFileURL(url) {
+    return url.startsWith('file:///');
+}
+
+async function fetchTransport(url, options) {
+    const response = await fetch(url, options);
+    if (!response.ok && !isFileURL(response.url)) {
+        throw new Error(`Request to ${response.url} ended with ${response.status} status.`);
+    }
+    return response;
+}
+
+function rq(url, options) {
+    return createRequest(fetchTransport, url, options);
+}
+
 exports.asserted = asserted;
 exports.capitalize = capitalize;
 exports.isBoolean = isBoolean;
@@ -259,5 +335,8 @@ exports.padZeros = padZeros;
 exports.readJSON = readJSON;
 exports.remove = remove;
 exports.removeFiles = removeFiles;
+exports.rq = rq;
+exports.rqc = createRequest;
 exports.sleep = sleep;
+exports.stringOrThrow = stringOrThrow;
 exports.toString = toString;

package/node/index.d.ts

@@ -17,6 +17,7 @@ declare function noop(): void;
 declare function toString(object: unknown): string;
 
 declare function asserted<T>(object: T | null | undefined): T;
+declare function stringOrThrow(value: unknown): asserts value is string;
 declare function isTruthy<T>(object: T): object is Exclude<T, '' | 0 | false | null | undefined>;
 declare function isFalsy(object: unknown): object is '' | 0 | false | null | undefined;
 declare function isNullish(object: unknown): object is null | undefined;
@@ -109,4 +110,28 @@ declare function removeFiles({ folderPath, filter }: RemoveFilesOpt): Promise<vo
 
 declare function readJSON<T = object>(filePath: string, withComments?: boolean): Promise<T>;
 
-export { Fn, Nullable, Prettify, asserted, capitalize, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, listFiles, listFolders, listFoldersSync, noop, padZeros, readJSON, remove, removeFiles, sleep, toString };
+interface RqRequest {
+    response: () => Promise<Response>;
+    blob: () => Promise<Blob>;
+    buffer: () => Promise<ArrayBuffer>;
+    json: <T = unknown>() => Promise<T>;
+    text: () => Promise<string>;
+    document: () => Promise<Document>;
+    multi: <T = unknown>(types: ResponseType[]) => Promise<Responses<T>>;
+}
+type Transport<TOptions = unknown> = (url: string, options?: TOptions) => Promise<Response>;
+type ResponseType = 'blob' | 'buffer' | 'document' | 'json' | 'text';
+interface Responses<T> {
+    response?: Response;
+    blob?: Blob;
+    buffer?: ArrayBuffer;
+    json?: T;
+    text?: string;
+    document?: Document;
+}
+
+declare function rq(url: string, options?: RequestInit): RqRequest;
+
+declare function createRequest<TOptions>(transport: Transport<TOptions>, url: string, options?: TOptions): RqRequest;
+
+export { Fn, Nullable, Prettify, asserted, capitalize, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, listFiles, listFolders, listFoldersSync, noop, padZeros, readJSON, remove, removeFiles, rq, createRequest as rqc, sleep, stringOrThrow, toString };

package/node/index.js

@@ -56,6 +56,11 @@ function asserted(object) {
     }
     return object;
 }
+function stringOrThrow(value) {
+    if (!isString(value)) {
+        throw new Error('Expected a string.');
+    }
+}
 function isTruthy(object) {
     return Boolean(object) === true;
 }
@@ -237,4 +242,75 @@ async function readJSON(filePath, withComments = false) {
     return JSON.parse(stringJSON);
 }
 
-export { asserted, capitalize, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, listFiles, listFolders, listFoldersSync, noop, padZeros, readJSON, remove, removeFiles, sleep, toString };
+function createRequest(transport, url, options) {
+    const getResponse = async () => {
+        return transport(url, options);
+    };
+    return {
+        response: async () => {
+            return getResponse();
+        },
+        blob: async () => {
+            const response = await getResponse();
+            return response.blob();
+        },
+        buffer: async () => {
+            const response = await getResponse();
+            return response.arrayBuffer();
+        },
+        json: async () => {
+            const response = await getResponse();
+            return response.json();
+        },
+        text: async () => {
+            const response = await getResponse();
+            return response.text();
+        },
+        document: async () => {
+            const response = await getResponse();
+            const responseText = await response.text();
+            const parser = new DOMParser();
+            return parser.parseFromString(responseText, 'text/html');
+        },
+        multi: async (types) => {
+            const response = await getResponse();
+            const responses = { response };
+            if (types.includes('blob')) {
+                responses.blob = await response.clone().blob();
+            }
+            if (types.includes('buffer')) {
+                responses.buffer = await response.clone().arrayBuffer();
+            }
+            if (types.includes('json')) {
+                responses.json = (await response.clone().json());
+            }
+            if (types.includes('text')) {
+                responses.text = await response.clone().text();
+            }
+            if (types.includes('document')) {
+                const responseText = await response.clone().text();
+                const parser = new DOMParser();
+                responses.document = parser.parseFromString(responseText, 'text/html');
+            }
+            return responses;
+        },
+    };
+}
+
+function isFileURL(url) {
+    return url.startsWith('file:///');
+}
+
+async function fetchTransport(url, options) {
+    const response = await fetch(url, options);
+    if (!response.ok && !isFileURL(response.url)) {
+        throw new Error(`Request to ${response.url} ended with ${response.status} status.`);
+    }
+    return response;
+}
+
+function rq(url, options) {
+    return createRequest(fetchTransport, url, options);
+}
+
+export { asserted, capitalize, isBoolean, isFalsy, isFunction, isNotNullish, isNullish, isNumber, isObject, isString, isTruthy, join, listFiles, listFolders, listFoldersSync, noop, padZeros, readJSON, remove, removeFiles, rq, createRequest as rqc, sleep, stringOrThrow, toString };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jeniex/utils",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "author": "JenieX",
   "homepage": "https://github.com/JenieX/utils",
   "type": "module",