@cedx/base 0.6.0 → 0.7.0

package/lib/{Http → Net/Http}/HttpClient.js

@@ -1,4 +1,6 @@
-import { HttpError } from "./HttpError.js";
+import { MediaType } from "../Mime/MediaType.js";
+import { HttpMethod } from "./HttpMethod.js";
+import { HttpRequestError } from "./HttpRequestError.js";
 /**
  * Performs HTTP requests.
  */
@@ -6,7 +8,7 @@ export class HttpClient {
     /**
      * The base URL of the remote service.
      */
-    baseUrl;
+    baseAddress;
     /**
      * The function returning the component used as loading indicator.
      */
@@ -17,8 +19,8 @@ export class HttpClient {
      */
     constructor(options = {}) {
         const url = options.baseUrl ? (options.baseUrl instanceof URL ? options.baseUrl.href : options.baseUrl) : document.baseURI;
-        this.baseUrl = new URL(url.endsWith("/") ? url : `${url}/`);
-        this.#loadingIndicator = options.loadingIndicator ?? (() => document.body.querySelector("loading-indicator"));
+        this.baseAddress = new URL(url.endsWith("/") ? url : `${url}/`);
+        this.#loadingIndicator = options.loadingIndicator ?? (() => document.body.querySelector("loading-indicator, .loading-indicator"));
     }
     /**
      * Performs a DELETE request.
@@ -27,7 +29,7 @@ export class HttpClient {
      * @returns The server response.
      */
     delete(url, options) {
-        return this.#fetch("DELETE", url, null, options);
+        return this.#fetch(HttpMethod.Delete, url, null, options);
     }
     /**
      * Performs a GET request.
@@ -36,7 +38,7 @@ export class HttpClient {
      * @returns The server response.
      */
     get(url, options) {
-        return this.#fetch("GET", url, null, options);
+        return this.#fetch(HttpMethod.Get, url, null, options);
     }
     /**
      * Performs a PATCH request.
@@ -46,7 +48,7 @@ export class HttpClient {
      * @returns The server response.
      */
     patch(url, body, options) {
-        return this.#fetch("PATCH", url, body, options);
+        return this.#fetch(HttpMethod.Patch, url, body, options);
     }
     /**
      * Performs a POST request.
@@ -56,7 +58,7 @@ export class HttpClient {
      * @returns The server response.
      */
     post(url, body, options) {
-        return this.#fetch("POST", url, body, options);
+        return this.#fetch(HttpMethod.Post, url, body, options);
     }
     /**
      * Performs a PUT request.
@@ -66,7 +68,7 @@ export class HttpClient {
      * @returns The server response.
      */
     put(url, body, options) {
-        return this.#fetch("PUT", url, body, options);
+        return this.#fetch(HttpMethod.Put, url, body, options);
     }
     /**
      * Performs a custom HTTP request.
@@ -78,21 +80,21 @@ export class HttpClient {
      */
     async #fetch(method, url = "", body = null, options = {}) {
         const headers = new Headers(options.headers);
-        if (!headers.has("accept"))
-            headers.set("accept", "application/json");
+        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", "application/json");
+            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.baseUrl), { ...options, method, headers, body });
+            const request = new Request(new URL(url, this.baseAddress), { ...options, method, headers, body });
             const response = await fetch(request);
             if (!response.ok)
-                throw new HttpError(response);
+                throw new HttpRequestError(response);
             return response;
         }
         finally {

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

@@ -0,0 +1,46 @@
+/**
+ * Provides HTTP methods.
+ */
+export declare const HttpMethod: Readonly<{
+    /**
+     * The `CONNECT` HTTP method.
+     */
+    Connect: "CONNECT";
+    /**
+     * The `DELETE` HTTP method.
+     */
+    Delete: "DELETE";
+    /**
+     * The `GET` HTTP method.
+     */
+    Get: "GET";
+    /**
+     * The `HEAD` HTTP method.
+     */
+    Head: "HEAD";
+    /**
+     * The `OPTIONS` HTTP method.
+     */
+    Options: "OPTIONS";
+    /**
+     * The `PATCH` HTTP method.
+     */
+    Patch: "PATCH";
+    /**
+     * The `POST` HTTP method.
+     */
+    Post: "POST";
+    /**
+     * The `PUT` HTTP method.
+     */
+    Put: "PUT";
+    /**
+     * The `TRACE` HTTP method.
+     */
+    Trace: "TRACE";
+}>;
+/**
+ * Provides HTTP methods.
+ */
+export type HttpMethod = typeof HttpMethod[keyof typeof HttpMethod];
+//# sourceMappingURL=HttpMethod.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"HttpMethod.d.ts","sourceRoot":"","sources":["../../../src/Client/Net/Http/HttpMethod.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,UAAU;IAEtB;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;EAEF,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,MAAM,OAAO,UAAU,CAAC,CAAC"}

package/lib/Net/Http/HttpMethod.js

@@ -0,0 +1,41 @@
+/**
+ * Provides HTTP methods.
+ */
+export const HttpMethod = Object.freeze({
+    /**
+     * The `CONNECT` HTTP method.
+     */
+    Connect: "CONNECT",
+    /**
+     * The `DELETE` HTTP method.
+     */
+    Delete: "DELETE",
+    /**
+     * The `GET` HTTP method.
+     */
+    Get: "GET",
+    /**
+     * The `HEAD` HTTP method.
+     */
+    Head: "HEAD",
+    /**
+     * The `OPTIONS` HTTP method.
+     */
+    Options: "OPTIONS",
+    /**
+     * The `PATCH` HTTP method.
+     */
+    Patch: "PATCH",
+    /**
+     * The `POST` HTTP method.
+     */
+    Post: "POST",
+    /**
+     * The `PUT` HTTP method.
+     */
+    Put: "PUT",
+    /**
+     * The `TRACE` HTTP method.
+     */
+    Trace: "TRACE"
+});

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

@@ -0,0 +1,33 @@
+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

@@ -0,0 +1 @@
+{"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/{Http/HttpError.js → Net/Http/HttpRequestError.js}

@@ -1,44 +1,44 @@
-import { StatusCodes } from "./StatusCodes.js";
+import { StatusCode } from "./StatusCode.js";
 /**
- * An object thrown when an HTTP error occurs.
+ * An error thrown by the HTTP client.
  */
-export class HttpError extends globalThis.Error {
+export class HttpRequestError extends globalThis.Error {
     /**
      * The validation errors.
      */
     #validationErrors = null;
     /**
      * Creates a new HTTP error.
-     * @param response The server response.
+     * @param response The HTTP response.
      */
     constructor(response) {
         super(`${response.status} ${response.statusText}`, { cause: response });
-        this.name = "HttpError";
+        this.name = "HttpRequestError";
     }
     /**
-     * The server response.
+     * The HTTP response.
      */
     get cause() {
         return super.cause;
     }
     /**
-     * Value indicating whether the response's status code is between 400 and 499.
+     * Value indicating whether the HTTP status code is between 400 and 499.
      */
     get isClientError() {
-        const { status } = this;
-        return status >= 400 && status < 500;
+        const { statusCode } = this;
+        return statusCode >= 400 && statusCode < 500;
     }
     /**
-     * Value indicating whether the response's status code is between 500 and 599.
+     * Value indicating whether the HTTP status code is between 500 and 599.
      */
     get isServerError() {
-        const { status } = this;
-        return status >= 500 && status < 600;
+        const { statusCode } = this;
+        return statusCode >= 500 && statusCode < 600;
     }
     /**
-     * The response's status code.
+     * The HTTP status code.
      */
-    get status() {
+    get statusCode() {
         return this.cause.status;
     }
     /**
@@ -55,8 +55,8 @@ export class HttpError extends globalThis.Error {
      */
     async #parseValidationErrors() {
         try {
-            const statuses = new Set([StatusCodes.BadRequest, StatusCodes.UnprocessableContent]);
-            const ignoreBody = this.cause.bodyUsed || !statuses.has(this.status);
+            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 {

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

@@ -0,0 +1,122 @@
+/**
+ * Provides common HTTP status codes.
+ */
+export declare const StatusCode: Readonly<{
+    /**
+     * The `OK` status code.
+     */
+    OK: 200;
+    /**
+     * The `Created` status code.
+     */
+    Created: 201;
+    /**
+     * The `No Content` status code.
+     */
+    NoContent: 204;
+    /**
+     * The `Moved Permanently` status code.
+     */
+    MovedPermanently: 301;
+    /**
+     * The `Found` status code.
+     */
+    Found: 302;
+    /**
+     * The `Not Modified` status code.
+     */
+    NotModified: 304;
+    /**
+     * The `Temporary Redirect` status code.
+     */
+    TemporaryRedirect: 307;
+    /**
+     * The `Permanent Redirect` status code.
+     */
+    PermanentRedirect: 308;
+    /**
+     * The `Bad Request` status code.
+     */
+    BadRequest: 400;
+    /**
+     * The `Unauthorized` status code.
+     */
+    Unauthorized: 401;
+    /**
+     * The `Payment Required` status code.
+     */
+    PaymentRequired: 402;
+    /**
+     * The `Forbidden` status code.
+     */
+    Forbidden: 403;
+    /**
+     * The `Not Found` status code.
+     */
+    NotFound: 404;
+    /**
+     * The `Method Not Allowed` status code.
+     */
+    MethodNotAllowed: 405;
+    /**
+     * The `Not Acceptable` status code.
+     */
+    NotAcceptable: 406;
+    /**
+     * The `Request Timeout` status code.
+     */
+    RequestTimeout: 408;
+    /**
+     * The `Conflict` status code.
+     */
+    Conflict: 409;
+    /**
+     * The `Payload Too Large` status code.
+     */
+    PayloadTooLarge: 413;
+    /**
+     * The `Unsupported Media Type` status code.
+     */
+    UnsupportedMediaType: 415;
+    /**
+     * The `Authentication Timeout` status code.
+     */
+    AuthenticationTimeout: 419;
+    /**
+     * The `Unprocessable Content` status code.
+     */
+    UnprocessableContent: 422;
+    /**
+     * The `Too Many Requests` status code.
+     */
+    TooManyRequests: 429;
+    /**
+     * The `Internal Server Error` status code.
+     */
+    InternalServerError: 500;
+    /**
+     * The `Not Implemented` status code.
+     */
+    NotImplemented: 501;
+    /**
+     * The `Bad Gateway` status code.
+     */
+    BadGateway: 502;
+    /**
+     * The `Service Unavailable` status code.
+     */
+    ServiceUnavailable: 503;
+    /**
+     * The `Gateway Timeout` status code.
+     */
+    GatewayTimeout: 504;
+    /**
+     * The `Bandwidth Limit Exceeded` status
+     */
+    BandwidthLimitExceeded: 509;
+}>;
+/**
+ * Provides common HTTP status codes.
+ */
+export type StatusCode = typeof StatusCode[keyof typeof StatusCode];
+//# sourceMappingURL=StatusCode.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StatusCode.d.ts","sourceRoot":"","sources":["../../../src/Client/Net/Http/StatusCode.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,UAAU;IAEtB;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;EAEF,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,MAAM,OAAO,UAAU,CAAC,CAAC"}

package/lib/Net/Http/StatusCode.js

@@ -0,0 +1,117 @@
+/**
+ * Provides common HTTP status codes.
+ */
+export const StatusCode = Object.freeze({
+    /**
+     * The `OK` status code.
+     */
+    OK: 200,
+    /**
+     * The `Created` status code.
+     */
+    Created: 201,
+    /**
+     * The `No Content` status code.
+     */
+    NoContent: 204,
+    /**
+     * The `Moved Permanently` status code.
+     */
+    MovedPermanently: 301,
+    /**
+     * The `Found` status code.
+     */
+    Found: 302,
+    /**
+     * The `Not Modified` status code.
+     */
+    NotModified: 304,
+    /**
+     * The `Temporary Redirect` status code.
+     */
+    TemporaryRedirect: 307,
+    /**
+     * The `Permanent Redirect` status code.
+     */
+    PermanentRedirect: 308,
+    /**
+     * The `Bad Request` status code.
+     */
+    BadRequest: 400,
+    /**
+     * The `Unauthorized` status code.
+     */
+    Unauthorized: 401,
+    /**
+     * The `Payment Required` status code.
+     */
+    PaymentRequired: 402,
+    /**
+     * The `Forbidden` status code.
+     */
+    Forbidden: 403,
+    /**
+     * The `Not Found` status code.
+     */
+    NotFound: 404,
+    /**
+     * The `Method Not Allowed` status code.
+     */
+    MethodNotAllowed: 405,
+    /**
+     * The `Not Acceptable` status code.
+     */
+    NotAcceptable: 406,
+    /**
+     * The `Request Timeout` status code.
+     */
+    RequestTimeout: 408,
+    /**
+     * The `Conflict` status code.
+     */
+    Conflict: 409,
+    /**
+     * The `Payload Too Large` status code.
+     */
+    PayloadTooLarge: 413,
+    /**
+     * The `Unsupported Media Type` status code.
+     */
+    UnsupportedMediaType: 415,
+    /**
+     * The `Authentication Timeout` status code.
+     */
+    AuthenticationTimeout: 419,
+    /**
+     * The `Unprocessable Content` status code.
+     */
+    UnprocessableContent: 422,
+    /**
+     * The `Too Many Requests` status code.
+     */
+    TooManyRequests: 429,
+    /**
+     * The `Internal Server Error` status code.
+     */
+    InternalServerError: 500,
+    /**
+     * The `Not Implemented` status code.
+     */
+    NotImplemented: 501,
+    /**
+     * The `Bad Gateway` status code.
+     */
+    BadGateway: 502,
+    /**
+     * The `Service Unavailable` status code.
+     */
+    ServiceUnavailable: 503,
+    /**
+     * The `Gateway Timeout` status code.
+     */
+    GatewayTimeout: 504,
+    /**
+     * The `Bandwidth Limit Exceeded` status
+     */
+    BandwidthLimitExceeded: 509
+});

package/lib/Net/Mime/DispositionType.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Provides the strings used to specify the disposition type.
+ */
+export declare const DispositionType: Readonly<{
+    /**
+     * The `attachment` disposition type.
+     */
+    Attachment: "attachment";
+    /**
+     * The `inline` disposition type.
+     */
+    Inline: "inline";
+}>;
+/**
+ * Provides the strings used to specify the disposition type.
+ */
+export type DispositionType = typeof DispositionType[keyof typeof DispositionType];
+//# sourceMappingURL=DispositionType.d.ts.map

package/lib/Net/Mime/DispositionType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DispositionType.d.ts","sourceRoot":"","sources":["../../../src/Client/Net/Mime/DispositionType.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,eAAe;IAE3B;;OAEG;;IAGH;;OAEG;;EAEF,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,eAAe,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC"}

package/lib/Net/Mime/DispositionType.js

@@ -0,0 +1,13 @@
+/**
+ * Provides the strings used to specify the disposition type.
+ */
+export const DispositionType = Object.freeze({
+    /**
+     * The `attachment` disposition type.
+     */
+    Attachment: "attachment",
+    /**
+     * The `inline` disposition type.
+     */
+    Inline: "inline"
+});