@e-mc/request 0.10.1 → 0.10.3

package/LICENSE

@@ -1,11 +1,11 @@
-Copyright 2024 An Pham
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
+Copyright 2024 An Pham
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,215 +1,216 @@
-# @e-mc/request
-
-* NodeJS 16
-* ES2020
-
-## General Usage
-
-* [Read the Docs](https://e-mc.readthedocs.io)
-
-## Interface
-
-* [View Source](https://www.unpkg.com/@e-mc/types@0.10.1/lib/index.d.ts)
-
-```typescript
-import type { IModule, ModuleConstructor } from "./index";
-import type { HttpAgentSettings, HttpProtocolVersion, HttpRequestClient, InternetProtocolVersion } from "./http";
-import type { ApplyOptions, Aria2Options, FormDataPart, HeadersOnCallback, HostConfig, OpenOptions, PostOptions, ProxySettings, ReadExpectType, RequestInit, StatusOnCallback } from "./request";
-import type { DnsLookupSettings, RequestModule, RequestSettings } from "./settings";
-
-import type { ClientRequest, OutgoingHttpHeaders } from "http";
-import type { LookupFunction } from "net";
-import type { Writable } from "stream";
-
-interface IRequest extends IModule {
-    module: RequestModule;
-    startTime: number;
-    acceptEncoding: boolean;
-    keepAlive: boolean | null;
-    readTimeout: number;
-    readExpect: ReadExpectType;
-    proxy: ProxySettings | null;
-    init(config?: RequestInit): this;
-    apply(options: ApplyOptions): this;
-    addDns(hostname: string, address: string, timeout: number): void;
-    addDns(hostname: string, address: string, family?: string, timeout?: number): void;
-    lookupDns(hostname: string): LookupFunction;
-    proxyOf(uri: string, localhost?: boolean): ProxySettings | undefined;
-    statusOn(name: number | number[], callback: StatusOnCallback): void;
-    statusOn(name: number | number[], globUrl: string, callback: StatusOnCallback): void;
-    headersOn(name: string | string[], callback: HeadersOnCallback): void;
-    headersOn(name: string | string[], globUrl: string, callback: HeadersOnCallback): void;
-    headersOf(uri: string): OutgoingHttpHeaders | undefined;
-    aria2c(uri: string | URL, pathname: string): Promise<string[]>;
-    aria2c(uri: string | URL, options?: Aria2Options): Promise<string[]>;
-    json(uri: string | URL, options?: OpenOptions): Promise<object | null>;
-    pipe(uri: string | URL, to: Writable, options?: OpenOptions): Promise<null>;
-    opts(url: string | URL, options?: OpenOptions): HostConfig;
-    open(uri: string | URL, options: OpenOptions): HttpRequestClient;
-    head(uri: string | URL, options?: OpenOptions): ClientRequest;
-    post(uri: string | URL, data: unknown, contentType: string): Promise<Buffer | string | null>;
-    post(uri: string | URL, parts: FormDataPart[]): Promise<Buffer | string | null>;
-    post(uri: string | URL, form: Record<string, unknown>, parts: FormDataPart[]): Promise<Buffer | string | null>;
-    post(uri: string | URL, data: unknown, options: PostOptions): Promise<Buffer | string | null>;
-    post(uri: string | URL, data: unknown, contentType?: string, options?: PostOptions): Promise<Buffer | string | null>;
-    get(uri: string | URL, options?: OpenOptions): Promise<Buffer | object | string | null>;
-    detach(singleton?: boolean): void;
-    reset(): void;
-    close(): void;
-    set agentTimeout(value);
-    get agentTimeout(): number;
-    set httpVersion(value);
-    get httpVersion(): HttpProtocolVersion | null;
-    set ipVersion(value);
-    get ipVersion(): InternetProtocolVersion;
-    get settings(): RequestSettings;
-}
-
-interface RequestConstructor extends ModuleConstructor {
-    readCACert(value: string, cache?: boolean): string;
-    readTLSKey(value: string, cache?: boolean): string;
-    readTLSCert(value: string, cache?: boolean): string;
-    isCert(value: string): boolean;
-    fromURL(url: URL, value: string): string;
-    fromStatusCode(value: number | string): string;
-    defineHttpAgent(options: HttpAgentSettings): void;
-    defineDnsLookup(options: DnsLookupSettings, clear?: boolean): void;
-    getAria2Path(): string;
-    readonly prototype: IRequest;
-    new(module?: RequestModule): IRequest;
-}
-```
-
-## Settings
-
-```typescript
-import type { PermittedDirectories } from "./core";
-import type { SecureConfig } from "./http";
-import type { PurgeComponent } from "./settings";
-
-import type { LookupAddress } from "dns";
-import type { OutgoingHttpHeaders } from "http";
-
-interface RequestModule {
-    handler: "@e-mc/request";
-    timeout?: number | string;
-    read_timeout?: number | string;
-    agent?: {
-        keep_alive?: boolean;
-        timeout?: number | string;
-    };
-    connect?: {
-        timeout?: number | string;
-        retry_wait?: number | string;
-        retry_after?: number | string;
-        retry_limit?: number;
-        redirect_limit?: number;
-    };
-    dns?: {
-        family?: number;
-        expires?: number | string;
-        resolve?: Record<string, Partial<LookupAddress>>;
-    };
-    use?: {
-        http_version?: 1 | 2;
-        accept_encoding?: boolean;
-    };
-    proxy?: {
-        address?: string;
-        port?: number;
-        origin?: string;
-        username?: string;
-        password?: string;
-        include?: string[];
-        exclude?: string[];
-        keep_alive?: boolean;
-    };
-    headers: Record<string, OutgoingHttpHeaders>;
-    certs?: Record<string, SecureConfig<string | string[]>>;
-    localhost?: string[];
-    protocol?: {
-        "http/1.1"?: string[];
-        h2c?: string[];
-        h2?: string[];
-    };
-    write_stream?: Record<string, number | string>;
-    post_limit?: number | string;
-    settings?: {
-        broadcast_id?: string | string[];
-        time_format?: "readable" | "relative" | "none";
-        purge?: PurgeComponent;
-    }
-}
-
-interface DownloadModule {
-    expires?: number | string;
-    aria2?: {
-        bin?: string | false;
-        exec?: {
-            uid?: number;
-            gid?: number;
-        };
-        update_status?: number | { interval?: number; broadcast_only?: boolean };
-        max_concurrent_downloads?: number;
-        max_connection_per_server?: number;
-        check_integrity?: boolean;
-        bt_stop_timeout?: number;
-        bt_tracker_connect_timeout?: number;
-        bt_tracker_timeout?: number;
-        min_split_size?: string;
-        disk_cache?: number | string;
-        lowest_speed_limit?: number | string;
-        always_resume?: boolean;
-        file_allocation?: "none" | "prealloc" | "trunc" | "falloc";
-        conf_path?: string;
-    };
-}
-```
-
-### Example usage
-
-```javascript
-const Request = require("@e-mc/request");
-
-const instance = new Request({
-    read_timeout: 30,
-    connect: {
-        timeout: 20, // Seconds
-        retry_wait: 1,
-        retry_after: 30,
-        retry_limit: 3, // Max attempts
-        redirect_limit: 10
-    },
-    use: {
-        http_version: 2,
-        accept_encoding: true
-    },
-    dns: {
-        family: 4 // ipVersion
-    },
-    agent: { keep_alive: true }
-});
-request.init({ ipVersion: 6 });
-
-const options = {
-    format: "yaml",
-    httpVersion: 1,
-    silent: true,
-    headers: { "x-goog-user-project": "project-1" }
-};
-instance.get("http://hostname/path/config.yml", options).then(data => {
-    console.log(data.property);
-});
-```
-
-## References
-
-- https://www.unpkg.com/@e-mc/types@0.10.1/lib/http.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.1/lib/request.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.1/lib/settings.d.ts
-
-* https://www.npmjs.com/package/@types/node
-
-## LICENSE
-
+# @e-mc/request
+
+* NodeJS 16
+* ES2020
+
+## General Usage
+
+* [Read the Docs](https://e-mc.readthedocs.io)
+
+## Interface
+
+* [View Source](https://www.unpkg.com/@e-mc/types@0.10.3/lib/index.d.ts)
+
+```typescript
+import type { IModule, ModuleConstructor } from "./index";
+import type { HttpAgentSettings, HttpProtocolVersion, HttpRequestClient, InternetProtocolVersion } from "./http";
+import type { ApplyOptions, Aria2Options, FormDataPart, HeadersOnCallback, HostConfig, OpenOptions, PostOptions, ProxySettings, PutOptions, ReadExpectType, RequestInit, StatusOnCallback } from "./request";
+import type { DnsLookupSettings, RequestModule, RequestSettings } from "./settings";
+
+import type { ClientRequest, OutgoingHttpHeaders } from "http";
+import type { LookupFunction } from "net";
+import type { Writable } from "stream";
+
+interface IRequest extends IModule {
+    module: RequestModule;
+    startTime: number;
+    acceptEncoding: boolean;
+    keepAlive: boolean | null;
+    readTimeout: number;
+    readExpect: ReadExpectType;
+    proxy: ProxySettings | null;
+    init(config?: RequestInit): this;
+    apply(options: ApplyOptions): this;
+    addDns(hostname: string, address: string, timeout: number): void;
+    addDns(hostname: string, address: string, family?: string, timeout?: number): void;
+    lookupDns(hostname: string): LookupFunction;
+    proxyOf(uri: string, localhost?: boolean): ProxySettings | undefined;
+    statusOn(name: number | number[], callback: StatusOnCallback): void;
+    statusOn(name: number | number[], globUrl: string, callback: StatusOnCallback): void;
+    headersOn(name: string | string[], callback: HeadersOnCallback): void;
+    headersOn(name: string | string[], globUrl: string, callback: HeadersOnCallback): void;
+    headersOf(uri: string): OutgoingHttpHeaders | undefined;
+    aria2c(uri: string | URL, pathname: string): Promise<string[]>;
+    aria2c(uri: string | URL, options?: Aria2Options): Promise<string[]>;
+    json(uri: string | URL, options?: OpenOptions): Promise<object | null>;
+    pipe(uri: string | URL, to: Writable, options?: OpenOptions): Promise<null>;
+    opts(url: string | URL, options?: OpenOptions): HostConfig;
+    open(uri: string | URL, options: OpenOptions): HttpRequestClient;
+    head(uri: string | URL, options?: OpenOptions): ClientRequest;
+    put(uri: string | URL, data: unknown, options: PutOptions): Promise<Buffer | string | null>;
+    put(uri: string | URL, data: unknown, contentType?: string, options?: PutOptions): Promise<Buffer | string | null>;
+    post(uri: string | URL, parts: FormDataPart[]): Promise<Buffer | string | null>;
+    post(uri: string | URL, form: Record<string, unknown>, parts: FormDataPart[]): Promise<Buffer | string | null>;
+    post(uri: string | URL, data: unknown, options: PostOptions): Promise<Buffer | string | null>;
+    post(uri: string | URL, data: unknown, contentType?: string, options?: PostOptions): Promise<Buffer | string | null>;
+    get(uri: string | URL, options?: OpenOptions): Promise<Buffer | object | string | null>;
+    detach(singleton?: boolean): void;
+    reset(): void;
+    close(): void;
+    set agentTimeout(value);
+    get agentTimeout(): number;
+    set httpVersion(value);
+    get httpVersion(): HttpProtocolVersion | null;
+    set ipVersion(value);
+    get ipVersion(): InternetProtocolVersion;
+    get settings(): RequestSettings;
+}
+
+interface RequestConstructor extends ModuleConstructor {
+    readCACert(value: string, cache?: boolean): string;
+    readTLSKey(value: string, cache?: boolean): string;
+    readTLSCert(value: string, cache?: boolean): string;
+    isCert(value: string): boolean;
+    fromURL(url: URL, value: string): string;
+    fromStatusCode(value: number | string): string;
+    defineHttpAgent(options: HttpAgentSettings): void;
+    defineDnsLookup(options: DnsLookupSettings, clear?: boolean): void;
+    getAria2Path(): string;
+    readonly prototype: IRequest;
+    new(module?: RequestModule): IRequest;
+}
+```
+
+## Settings
+
+```typescript
+import type { PermittedDirectories } from "./core";
+import type { SecureConfig } from "./http";
+import type { PurgeComponent } from "./settings";
+
+import type { LookupAddress } from "dns";
+import type { OutgoingHttpHeaders } from "http";
+
+interface RequestModule {
+    handler: "@e-mc/request";
+    timeout?: number | string;
+    read_timeout?: number | string;
+    agent?: {
+        keep_alive?: boolean;
+        timeout?: number | string;
+    };
+    connect?: {
+        timeout?: number | string;
+        retry_wait?: number | string;
+        retry_after?: number | string;
+        retry_limit?: number;
+        redirect_limit?: number;
+    };
+    dns?: {
+        family?: number;
+        expires?: number | string;
+        resolve?: Record<string, Partial<LookupAddress>>;
+    };
+    use?: {
+        http_version?: 1 | 2;
+        accept_encoding?: boolean;
+    };
+    proxy?: {
+        address?: string;
+        port?: number;
+        origin?: string;
+        username?: string;
+        password?: string;
+        include?: string[];
+        exclude?: string[];
+        keep_alive?: boolean;
+    };
+    headers: Record<string, OutgoingHttpHeaders>;
+    certs?: Record<string, SecureConfig<string | string[]>>;
+    localhost?: string[];
+    protocol?: {
+        "http/1.1"?: string[];
+        h2c?: string[];
+        h2?: string[];
+    };
+    write_stream?: Record<string, number | string>;
+    post_limit?: number | string;
+    settings?: {
+        broadcast_id?: string | string[];
+        time_format?: "readable" | "relative" | "none";
+        purge?: PurgeComponent;
+    }
+}
+
+interface DownloadModule {
+    expires?: number | string;
+    aria2?: {
+        bin?: string | false;
+        exec?: {
+            uid?: number;
+            gid?: number;
+        };
+        update_status?: number | { interval?: number; broadcast_only?: boolean };
+        max_concurrent_downloads?: number;
+        max_connection_per_server?: number;
+        check_integrity?: boolean;
+        bt_stop_timeout?: number;
+        bt_tracker_connect_timeout?: number;
+        bt_tracker_timeout?: number;
+        min_split_size?: string;
+        disk_cache?: number | string;
+        lowest_speed_limit?: number | string;
+        always_resume?: boolean;
+        file_allocation?: "none" | "prealloc" | "trunc" | "falloc";
+        conf_path?: string;
+    };
+}
+```
+
+### Example usage
+
+```javascript
+const Request = require("@e-mc/request");
+
+const instance = new Request({
+    read_timeout: 30,
+    connect: {
+        timeout: 20, // Seconds
+        retry_wait: 1,
+        retry_after: 30,
+        retry_limit: 3, // Max attempts
+        redirect_limit: 10
+    },
+    use: {
+        http_version: 2,
+        accept_encoding: true
+    },
+    dns: {
+        family: 4 // ipVersion
+    },
+    agent: { keep_alive: true }
+});
+request.init({ ipVersion: 6 });
+
+const options = {
+    format: "yaml",
+    httpVersion: 1,
+    silent: true,
+    headers: { "x-goog-user-project": "project-1" }
+};
+instance.get("http://hostname/path/config.yml", options).then(data => {
+    console.log(data.property);
+});
+```
+
+## References
+
+- https://www.unpkg.com/@e-mc/types@0.10.3/lib/http.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.3/lib/request.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.3/lib/settings.d.ts
+
+* https://www.npmjs.com/package/@types/node
+
+## LICENSE
+
 BSD 3-Clause

package/http/host/index.d.ts

@@ -1,5 +1,5 @@
-import type { HttpHostConstructor } from '../../../types/lib/request';
-
-declare const HttpHost: HttpHostConstructor;
-
+import type { HttpHostConstructor } from '@e-mc/types/lib/request';
+
+declare const HttpHost: HttpHostConstructor;
+
 export = HttpHost;

package/http/host/index.js

@@ -120,7 +120,7 @@ class HttpHost {
                 case 1:
                     return status;
                 default:
-                    return this._tlsConnect || (this._tlsConnect = new Promise(resolve => {
+                    return this._tlsConnect ||= new Promise(resolve => {
                         const alpn = 'h' + version;
                         const socket = tls.connect(+this.port, this.hostname, { ALPNProtocols: [alpn], requestCert: true, rejectUnauthorized: false }, () => {
                             this._tlsConnect = null;
@@ -147,7 +147,7 @@ class HttpHost {
                             resolve(data[3] = 0);
                         })
                             .end();
-                    }));
+                    });
             }
         }
         return 1;

package/index.d.ts

@@ -1,5 +1,5 @@
-import type { RequestConstructor } from '../types/lib';
-
-declare const Request: RequestConstructor;
-
+import type { RequestConstructor } from '@e-mc/types/lib';
+
+declare const Request: RequestConstructor;
+
 export = Request;