@cedx/base 0.1.0

package/lib/Http/HttpError.js

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

package/lib/Http/StatusCodes.d.ts

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

package/lib/Http/StatusCodes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StatusCodes.d.ts","sourceRoot":"","sources":["../../src/Client/Http/StatusCodes.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,WAAW;IAEvB;;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,WAAW,GAAG,OAAO,WAAW,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC"}

package/lib/Http/StatusCodes.js

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

package/lib/Number.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Rounds a floating-point number.
+ * @param value The value to round.
+ * @param precision The optional number of decimal digits to round to.
+ * @returns The value rounded to the given precision.
+ */
+export declare function round(value: number, precision?: number): number;
+//# sourceMappingURL=Number.d.ts.map

package/lib/Number.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Number.d.ts","sourceRoot":"","sources":["../src/Client/Number.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,SAAI,GAAG,MAAM,CAG1D"}

package/lib/Number.js

@@ -0,0 +1,10 @@
+/**
+ * Rounds a floating-point number.
+ * @param value The value to round.
+ * @param precision The optional number of decimal digits to round to.
+ * @returns The value rounded to the given precision.
+ */
+export function round(value, precision = 0) {
+    const operand = 10 ** precision;
+    return Math.round(value * operand) / operand;
+}

package/lib/UI/LoadingIndicator.d.ts

@@ -0,0 +1,40 @@
+import type { ILoadingIndicator } from "#Abstractions/ILoadingIndicator.js";
+import { LitElement, type TemplateResult } from "lit";
+/**
+ * A component that shows up when an HTTP request starts, and hides when all concurrent HTTP requests are completed.
+ */
+export declare class LoadingIndicator extends LitElement implements ILoadingIndicator {
+    #private;
+    /**
+     * Creates a new loading indicator.
+     */
+    constructor();
+    /**
+     * 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;
+    /**
+     * Renders this component.
+     * @returns The view template.
+     */
+    protected render(): TemplateResult;
+}
+/**
+ * Declaration merging.
+ */
+declare global {
+    /**
+     * The map of HTML tag names.
+     */
+    interface HTMLElementTagNameMap {
+        "loading-indicator": LoadingIndicator;
+    }
+}
+//# sourceMappingURL=LoadingIndicator.d.ts.map

package/lib/UI/LoadingIndicator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LoadingIndicator.d.ts","sourceRoot":"","sources":["../../src/Client/UI/LoadingIndicator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAO,UAAU,EAAE,KAAK,cAAc,EAAC,MAAM,KAAK,CAAC;AAG1D;;GAEG;AACH,qBACa,gBAAiB,SAAQ,UAAW,YAAW,iBAAiB;;IAO5E;;OAEG;;IAMH;;OAEG;IACH,KAAK,IAAI,IAAI;IAMb;;;OAGG;IACH,IAAI,CAAC,OAAO,GAAE;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAM,GAAG,IAAI;IAS3C;;;OAGG;cACgB,MAAM,IAAI,cAAc;CAG3C;AAED;;GAEG;AACH,OAAO,CAAC,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,qBAAqB;QAC9B,mBAAmB,EAAE,gBAAgB,CAAC;KACtC;CACD"}

package/lib/UI/LoadingIndicator.js

@@ -0,0 +1,50 @@
+import { __decorate } from "tslib";
+import { html, LitElement } from "lit";
+import { customElement } from "lit/decorators.js";
+/**
+ * A component that shows up when an HTTP request starts, and hides when all concurrent HTTP requests are completed.
+ */
+let LoadingIndicator = class LoadingIndicator extends LitElement {
+    /**
+     * The number of concurrent HTTP requests.
+     */
+    #requestCount = 0;
+    /**
+     * Creates a new loading indicator.
+     */
+    constructor() {
+        super();
+        this.hidden = true;
+    }
+    /**
+     * Starts the loading indicator.
+     */
+    start() {
+        this.#requestCount++;
+        this.hidden = false;
+        document.body.classList.add("loading");
+    }
+    /**
+     * Stops the loading indicator.
+     * @param options Value indicating whether to force the loading indicator to stop.
+     */
+    stop(options = {}) {
+        this.#requestCount--;
+        if (options.force || this.#requestCount <= 0) {
+            this.#requestCount = 0;
+            this.hidden = true;
+            document.body.classList.remove("loading");
+        }
+    }
+    /**
+     * Renders this component.
+     * @returns The view template.
+     */
+    render() {
+        return html `<slot></slot>`;
+    }
+};
+LoadingIndicator = __decorate([
+    customElement("loading-indicator")
+], LoadingIndicator);
+export { LoadingIndicator };

package/lib/UI/OfflineIndicator.d.ts

@@ -0,0 +1,39 @@
+import { LitElement, type TemplateResult } from "lit";
+/**
+ * A component that shows up when the network is unavailable, and hides when connectivity is restored.
+ */
+export declare class OfflineIndicator extends LitElement {
+    /**
+     * Creates a new offline indicator.
+     */
+    constructor();
+    /**
+     * Method invoked when this component is connected.
+     */
+    connectedCallback(): void;
+    /**
+     * Method invoked when this component is disconnected.
+     */
+    disconnectedCallback(): void;
+    /**
+     * Handles the events.
+     */
+    handleEvent(): void;
+    /**
+     * Renders this component.
+     * @returns The view template.
+     */
+    protected render(): TemplateResult;
+}
+/**
+ * Declaration merging.
+ */
+declare global {
+    /**
+     * The map of HTML tag names.
+     */
+    interface HTMLElementTagNameMap {
+        "offline-indicator": OfflineIndicator;
+    }
+}
+//# sourceMappingURL=OfflineIndicator.d.ts.map

package/lib/UI/OfflineIndicator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OfflineIndicator.d.ts","sourceRoot":"","sources":["../../src/Client/UI/OfflineIndicator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,UAAU,EAAE,KAAK,cAAc,EAAC,MAAM,KAAK,CAAC;AAG1D;;GAEG;AACH,qBACa,gBAAiB,SAAQ,UAAU;IAE/C;;OAEG;;IAMH;;OAEG;IACM,iBAAiB,IAAI,IAAI;IAKlC;;OAEG;IACM,oBAAoB,IAAI,IAAI;IAKrC;;OAEG;IACH,WAAW,IAAI,IAAI;IAInB;;;OAGG;cACgB,MAAM,IAAI,cAAc;CAG3C;AAED;;GAEG;AACH,OAAO,CAAC,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,qBAAqB;QAC9B,mBAAmB,EAAE,gBAAgB,CAAC;KACtC;CACD"}

package/lib/UI/OfflineIndicator.js

@@ -0,0 +1,48 @@
+import { __decorate } from "tslib";
+import { html, LitElement } from "lit";
+import { customElement } from "lit/decorators.js";
+/**
+ * A component that shows up when the network is unavailable, and hides when connectivity is restored.
+ */
+let OfflineIndicator = class OfflineIndicator extends LitElement {
+    /**
+     * Creates a new offline indicator.
+     */
+    constructor() {
+        super();
+        this.hidden = navigator.onLine;
+    }
+    /**
+     * Method invoked when this component is connected.
+     */
+    connectedCallback() {
+        super.connectedCallback();
+        for (const event of ["online", "offline"])
+            addEventListener(event, this);
+    }
+    /**
+     * Method invoked when this component is disconnected.
+     */
+    disconnectedCallback() {
+        for (const event of ["online", "offline"])
+            removeEventListener(event, this);
+        super.disconnectedCallback();
+    }
+    /**
+     * Handles the events.
+     */
+    handleEvent() {
+        this.hidden = navigator.onLine;
+    }
+    /**
+     * Renders this component.
+     * @returns The view template.
+     */
+    render() {
+        return html `<slot></slot>`;
+    }
+};
+OfflineIndicator = __decorate([
+    customElement("offline-indicator")
+], OfflineIndicator);
+export { OfflineIndicator };

package/lib/UI/ThemeDropdown.d.ts

@@ -0,0 +1,68 @@
+import { AppTheme } from "#Html/AppTheme.js";
+import { MenuAlignment } from "#Html/MenuAlignment.js";
+import { LitElement, type TemplateResult } from "lit";
+/**
+ * A dropdown menu for switching the color mode.
+ */
+export declare class ThemeDropdown extends LitElement {
+    #private;
+    /**
+     * The alignment of the dropdown menu.
+     */
+    alignment: MenuAlignment;
+    /**
+     * The label of the dropdown menu.
+     */
+    label: string;
+    /**
+     * The key of the storage entry providing the saved theme.
+     */
+    storageKey: string;
+    /**
+     * The current application theme.
+     */
+    private appTheme;
+    /**
+     * Creates a new theme dropdown.
+     */
+    constructor();
+    /**
+     * The current theme mode.
+     */
+    get theme(): AppTheme;
+    set theme(value: AppTheme);
+    /**
+     * Method invoked when this component is connected.
+     */
+    connectedCallback(): void;
+    /**
+     * Method invoked when this component is disconnected.
+     */
+    disconnectedCallback(): void;
+    /**
+     * Handles the events.
+     */
+    handleEvent(): void;
+    /**
+     * Returns the node into which this component should render.
+     * @returns The node into which this component should render.
+     */
+    protected createRenderRoot(): DocumentFragment | HTMLElement;
+    /**
+     * Renders this component.
+     * @returns The view template.
+     */
+    protected render(): TemplateResult;
+}
+/**
+ * Declaration merging.
+ */
+declare global {
+    /**
+     * The map of HTML tag names.
+     */
+    interface HTMLElementTagNameMap {
+        "theme-dropdown": ThemeDropdown;
+    }
+}
+//# sourceMappingURL=ThemeDropdown.d.ts.map

package/lib/UI/ThemeDropdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ThemeDropdown.d.ts","sourceRoot":"","sources":["../../src/Client/UI/ThemeDropdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAwB,MAAM,mBAAmB,CAAC;AAClE,OAAO,EAAC,aAAa,EAAC,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAO,UAAU,EAAE,KAAK,cAAc,EAAC,MAAM,KAAK,CAAC;AAK1D;;GAEG;AACH,qBACa,aAAc,SAAQ,UAAU;;IAE5C;;OAEG;IACS,SAAS,EAAE,aAAa,CAAqB;IAEzD;;OAEG;IACS,KAAK,SAAM;IAEvB;;OAEG;IACS,UAAU,SAAc;IAEpC;;OAEG;IACM,OAAO,CAAC,QAAQ,CAAW;IAOpC;;OAEG;;IAOH;;OAEG;IACH,IAAI,KAAK,IAAI,QAAQ,CAA0B;IAC/C,IAAI,KAAK,CAAC,KAAK,EAAE,QAAQ,EAGxB;IAED;;OAEG;IACM,iBAAiB,IAAI,IAAI;IAMlC;;OAEG;IACM,oBAAoB,IAAI,IAAI;IAKrC;;OAEG;IACH,WAAW,IAAI,IAAI;IAInB;;;OAGG;cACgB,gBAAgB,IAAI,gBAAgB,GAAC,WAAW;IAInE;;;OAGG;cACgB,MAAM,IAAI,cAAc;CA4B3C;AAED;;GAEG;AACH,OAAO,CAAC,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,qBAAqB;QAC9B,gBAAgB,EAAE,aAAa,CAAC;KAChC;CACD"}