@cedx/base 0.7.0 → 0.9.0

package/lib/Net/Http/HttpClient.js

@@ -1,104 +0,0 @@
-import { MediaType } from "../Mime/MediaType.js";
-import { HttpMethod } from "./HttpMethod.js";
-import { HttpRequestError } from "./HttpRequestError.js";
-/**
- * Performs HTTP requests.
- */
-export class HttpClient {
-    /**
-     * The base URL of the remote service.
-     */
-    baseAddress;
-    /**
-     * The function returning the component used as loading indicator.
-     */
-    #loadingIndicator;
-    /**
-     * Creates a new HTTP client.
-     * @param options An object providing values to initialize this instance.
-     */
-    constructor(options = {}) {
-        const url = options.baseUrl ? (options.baseUrl instanceof URL ? options.baseUrl.href : options.baseUrl) : document.baseURI;
-        this.baseAddress = new URL(url.endsWith("/") ? url : `${url}/`);
-        this.#loadingIndicator = options.loadingIndicator ?? (() => document.body.querySelector("loading-indicator, .loading-indicator"));
-    }
-    /**
-     * Performs a DELETE request.
-     * @param url The URL of the resource to fetch.
-     * @param options The request options.
-     * @returns The server response.
-     */
-    delete(url, options) {
-        return this.#fetch(HttpMethod.Delete, url, null, options);
-    }
-    /**
-     * Performs a GET request.
-     * @param url The URL of the resource to fetch.
-     * @param options The request options.
-     * @returns The server response.
-     */
-    get(url, options) {
-        return this.#fetch(HttpMethod.Get, url, null, options);
-    }
-    /**
-     * Performs a PATCH request.
-     * @param url The URL of the resource to fetch.
-     * @param body The request body.
-     * @param options The request options.
-     * @returns The server response.
-     */
-    patch(url, body, options) {
-        return this.#fetch(HttpMethod.Patch, url, body, options);
-    }
-    /**
-     * Performs a POST request.
-     * @param url The URL of the resource to fetch.
-     * @param body The request body.
-     * @param options The request options.
-     * @returns The server response.
-     */
-    post(url, body, options) {
-        return this.#fetch(HttpMethod.Post, url, body, options);
-    }
-    /**
-     * Performs a PUT request.
-     * @param url The URL of the resource to fetch.
-     * @param body The request body.
-     * @param options The request options.
-     * @returns The server response.
-     */
-    put(url, body, options) {
-        return this.#fetch(HttpMethod.Put, url, body, options);
-    }
-    /**
-     * Performs a custom HTTP request.
-     * @param method The HTTP method.
-     * @param url The URL of the resource to fetch.
-     * @param body The request body.
-     * @param options The request options.
-     * @returns The server response.
-     */
-    async #fetch(method, url = "", body = null, options = {}) {
-        const headers = new Headers(options.headers);
-        if (!headers.has("Accept"))
-            headers.set("Accept", MediaType.Application.Json);
-        if (body && !(body instanceof Blob || body instanceof FormData || body instanceof URLSearchParams)) {
-            if (typeof body != "string")
-                body = JSON.stringify(body);
-            if (!headers.has("Content-Type"))
-                headers.set("Content-Type", MediaType.Application.Json);
-        }
-        const loadingIndicator = this.#loadingIndicator();
-        try {
-            loadingIndicator?.start();
-            const request = new Request(new URL(url, this.baseAddress), { ...options, method, headers, body });
-            const response = await fetch(request);
-            if (!response.ok)
-                throw new HttpRequestError(response);
-            return response;
-        }
-        finally {
-            loadingIndicator?.stop();
-        }
-    }
-}

package/lib/Net/Http/HttpRequestError.d.ts

@@ -1,33 +0,0 @@
-import { StatusCode } from "./StatusCode.js";
-/**
- * An error thrown by the HTTP client.
- */
-export declare class HttpRequestError extends globalThis.Error {
-    #private;
-    /**
-     * Creates a new HTTP error.
-     * @param response The HTTP response.
-     */
-    constructor(response: Response);
-    /**
-     * The HTTP response.
-     */
-    get cause(): Response;
-    /**
-     * Value indicating whether the HTTP status code is between 400 and 499.
-     */
-    get isClientError(): boolean;
-    /**
-     * Value indicating whether the HTTP status code is between 500 and 599.
-     */
-    get isServerError(): boolean;
-    /**
-     * The HTTP status code.
-     */
-    get statusCode(): StatusCode;
-    /**
-     * The validation errors.
-     */
-    get validationErrors(): Promise<Map<string, string>>;
-}
-//# sourceMappingURL=HttpRequestError.d.ts.map

package/lib/Net/Http/HttpRequestError.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"HttpRequestError.d.ts","sourceRoot":"","sources":["../../../src/Client/Net/Http/HttpRequestError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,iBAAiB,CAAC;AAE3C;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,UAAU,CAAC,KAAK;;IAOrD;;;OAGG;gBACS,QAAQ,EAAE,QAAQ;IAK9B;;OAEG;IACH,IAAa,KAAK,IAAI,QAAQ,CAE7B;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,OAAO,CAG3B;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,OAAO,CAG3B;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,UAAU,CAE3B;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAInD;CAgBD"}

package/lib/Net/Http/HttpRequestError.js

@@ -1,66 +0,0 @@
-import { StatusCode } from "./StatusCode.js";
-/**
- * An error thrown by the HTTP client.
- */
-export class HttpRequestError extends globalThis.Error {
-    /**
-     * The validation errors.
-     */
-    #validationErrors = null;
-    /**
-     * Creates a new HTTP error.
-     * @param response The HTTP response.
-     */
-    constructor(response) {
-        super(`${response.status} ${response.statusText}`, { cause: response });
-        this.name = "HttpRequestError";
-    }
-    /**
-     * The HTTP response.
-     */
-    get cause() {
-        return super.cause;
-    }
-    /**
-     * Value indicating whether the HTTP status code is between 400 and 499.
-     */
-    get isClientError() {
-        const { statusCode } = this;
-        return statusCode >= 400 && statusCode < 500;
-    }
-    /**
-     * Value indicating whether the HTTP status code is between 500 and 599.
-     */
-    get isServerError() {
-        const { statusCode } = this;
-        return statusCode >= 500 && statusCode < 600;
-    }
-    /**
-     * The HTTP status code.
-     */
-    get statusCode() {
-        return this.cause.status;
-    }
-    /**
-     * The validation errors.
-     */
-    get validationErrors() {
-        return this.#validationErrors
-            ? Promise.resolve(this.#validationErrors)
-            : this.#parseValidationErrors().then(errors => this.#validationErrors = errors);
-    }
-    /**
-     * Parses the validation errors returned in the body of the specified response.
-     * @returns The validation errors provided by the response body.
-     */
-    async #parseValidationErrors() {
-        try {
-            const statuses = [StatusCode.BadRequest, StatusCode.UnprocessableContent];
-            const ignoreBody = this.cause.bodyUsed || !statuses.includes(this.statusCode);
-            return new Map(ignoreBody ? [] : Object.entries(await this.cause.json()));
-        }
-        catch {
-            return new Map;
-        }
-    }
-}

package/src/Client/Net/Http/HttpClient.ts

@@ -1,145 +0,0 @@
-import {MediaType} from "../Mime/MediaType.js";
-import {HttpMethod} from "./HttpMethod.js";
-import {HttpRequestError} from "./HttpRequestError.js";
-
-/**
- * Performs HTTP requests.
- */
-export class HttpClient {
-
-	/**
-	 * The base URL of the remote service.
-	 */
-	readonly baseAddress: URL;
-
-	/**
-	 * The function returning the component used as loading indicator.
-	 */
-	readonly #loadingIndicator: () => ILoadingIndicator|null;
-
-	/**
-	 * Creates a new HTTP client.
-	 * @param options An object providing values to initialize this instance.
-	 */
-	constructor(options: HttpClientOptions = {}) {
-		const url = options.baseUrl ? (options.baseUrl instanceof URL ? options.baseUrl.href : options.baseUrl) : document.baseURI;
-		this.baseAddress = new URL(url.endsWith("/") ? url : `${url}/`);
-		this.#loadingIndicator = options.loadingIndicator ?? (() => document.body.querySelector("loading-indicator, .loading-indicator") as ILoadingIndicator|null);
-	}
-
-	/**
-	 * Performs a DELETE request.
-	 * @param url The URL of the resource to fetch.
-	 * @param options The request options.
-	 * @returns The server response.
-	 */
-	delete(url?: string|URL, options?: RequestInit): Promise<Response> {
-		return this.#fetch(HttpMethod.Delete, url, null, options);
-	}
-
-	/**
-	 * Performs a GET request.
-	 * @param url The URL of the resource to fetch.
-	 * @param options The request options.
-	 * @returns The server response.
-	 */
-	get(url?: string|URL, options?: RequestInit): Promise<Response> {
-		return this.#fetch(HttpMethod.Get, url, null, options);
-	}
-
-	/**
-	 * Performs a PATCH request.
-	 * @param url The URL of the resource to fetch.
-	 * @param body The request body.
-	 * @param options The request options.
-	 * @returns The server response.
-	 */
-	patch(url?: string|URL, body?: unknown, options?: RequestInit): Promise<Response> {
-		return this.#fetch(HttpMethod.Patch, url, body, options);
-	}
-
-	/**
-	 * Performs a POST request.
-	 * @param url The URL of the resource to fetch.
-	 * @param body The request body.
-	 * @param options The request options.
-	 * @returns The server response.
-	 */
-	post(url?: string|URL, body?: unknown, options?: RequestInit): Promise<Response> {
-		return this.#fetch(HttpMethod.Post, url, body, options);
-	}
-
-	/**
-	 * Performs a PUT request.
-	 * @param url The URL of the resource to fetch.
-	 * @param body The request body.
-	 * @param options The request options.
-	 * @returns The server response.
-	 */
-	put(url?: string|URL, body?: unknown, options?: RequestInit): Promise<Response> {
-		return this.#fetch(HttpMethod.Put, url, body, options);
-	}
-
-	/**
-	 * Performs a custom HTTP request.
-	 * @param method The HTTP method.
-	 * @param url The URL of the resource to fetch.
-	 * @param body The request body.
-	 * @param options The request options.
-	 * @returns The server response.
-	 */
-	async #fetch(method: string, url: string|URL = "", body: unknown = null, options: RequestInit = {}): Promise<Response> {
-		const headers = new Headers(options.headers);
-		if (!headers.has("Accept")) headers.set("Accept", MediaType.Application.Json);
-
-		if (body && !(body instanceof Blob || body instanceof FormData || body instanceof URLSearchParams)) {
-			if (typeof body != "string") body = JSON.stringify(body);
-			if (!headers.has("Content-Type")) headers.set("Content-Type", MediaType.Application.Json);
-		}
-
-		const loadingIndicator = this.#loadingIndicator();
-		try {
-			loadingIndicator?.start();
-			const request = new Request(new URL(url, this.baseAddress), {...options, method, headers, body} as RequestInit);
-			const response = await fetch(request);
-			if (!response.ok) throw new HttpRequestError(response);
-			return response;
-		}
-		finally {
-			loadingIndicator?.stop();
-		}
-	}
-}
-
-/**
- * Defines the options of a {@link HttpClient} instance.
- */
-export type HttpClientOptions = Partial<{
-
-	/**
-	 * The base URL of the remote service.
-	 */
-	baseUrl: string|URL;
-
-	/**
-	 * The function returning the component used as loading indicator.
-	 */
-	loadingIndicator: () => ILoadingIndicator|null;
-}>;
-
-/**
- * A component that shows up when an HTTP request starts, and hides when all concurrent HTTP requests are completed.
- */
-export interface ILoadingIndicator {
-
-	/**
-	 * Starts the loading indicator.
-	 */
-	start: () => void;
-
-	/**
-	 * Stops the loading indicator.
-	 * @param options Value indicating whether to force the loading indicator to stop.
-	 */
-	stop: (options?: {force?: boolean}) => void;
-}

package/src/Client/Net/Http/HttpRequestError.ts

@@ -1,75 +0,0 @@
-import {StatusCode} from "./StatusCode.js";
-
-/**
- * An error thrown by the HTTP client.
- */
-export class HttpRequestError extends globalThis.Error {
-
-	/**
-	 * The validation errors.
-	 */
-	#validationErrors: Map<string, string>|null = null;
-
-	/**
-	 * Creates a new HTTP error.
-	 * @param response The HTTP response.
-	 */
-	constructor(response: Response) {
-		super(`${response.status} ${response.statusText}`, {cause: response});
-		this.name = "HttpRequestError";
-	}
-
-	/**
-	 * The HTTP response.
-	 */
-	override get cause(): Response {
-		return super.cause as Response;
-	}
-
-	/**
-	 * Value indicating whether the HTTP status code is between 400 and 499.
-	 */
-	get isClientError(): boolean {
-		const {statusCode} = this;
-		return statusCode >= 400 && statusCode < 500;
-	}
-
-	/**
-	 * Value indicating whether the HTTP status code is between 500 and 599.
-	 */
-	get isServerError(): boolean {
-		const {statusCode} = this;
-		return statusCode >= 500 && statusCode < 600;
-	}
-
-	/**
-	 * The HTTP status code.
-	 */
-	get statusCode(): StatusCode {
-		return this.cause.status as StatusCode;
-	}
-
-	/**
-	 * The validation errors.
-	 */
-	get validationErrors(): Promise<Map<string, string>> {
-		return this.#validationErrors
-			? Promise.resolve(this.#validationErrors)
-			: this.#parseValidationErrors().then(errors => this.#validationErrors = errors);
-	}
-
-	/**
-	 * Parses the validation errors returned in the body of the specified response.
-	 * @returns The validation errors provided by the response body.
-	 */
-	async #parseValidationErrors(): Promise<Map<string, string>> {
-		try {
-			const statuses: StatusCode[] = [StatusCode.BadRequest, StatusCode.UnprocessableContent];
-			const ignoreBody = this.cause.bodyUsed || !statuses.includes(this.statusCode);
-			return new Map(ignoreBody ? [] : Object.entries(await this.cause.json() as Record<string, string>));
-		}
-		catch {
-			return new Map;
-		}
-	}
-}