@cedx/base 0.6.0 → 0.8.0

package/lib/Http/StatusCodes.js

@@ -1,109 +0,0 @@
-/**
- * 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.map

@@ -1 +0,0 @@
-{"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/String.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"String.d.ts","sourceRoot":"","sources":["../src/Client/String.ts"],"names":[],"mappings":"AAWA;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,IAAI,CAAC,MAAM,GAAC,MAA2B,GAAG,MAAM,CAEjG;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,SAAI,GAAG,MAAM,EAAE,CAE9D;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAG5C;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAG1E;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,SAAQ,GAAG,MAAM,CAEhF;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE/C"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"Component.d.ts","sourceRoot":"","sources":["../../src/Client/UI/Component.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,KAAK,cAAc,EAAC,MAAM,KAAK,CAAC;AAEpD;;GAEG;AACH,8BAAsB,SAAU,SAAQ,UAAU;;IAEjD;;OAEG;IACH,OAAgB,MAAM,EAAE,cAAc,CAAiC;IAOvE;;;OAGG;gBACS,OAAO,GAAE;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAM;IAKhD;;;OAGG;cACgB,gBAAgB,IAAI,gBAAgB,GAAC,WAAW;CAGnE"}

package/lib/UI/Component.js

@@ -1,29 +0,0 @@
-import { LitElement } from "lit";
-/**
- * The optional base class for UI components. Alternatively, components may extend {@link LitElement} directly.
- */
-export class Component extends LitElement {
-    /**
-     * The component styles.
-     */
-    static styles = [document.adoptedStyleSheets];
-    /**
-     * Value indicating whether this component uses a shadow root.
-     */
-    #useShadowRoot;
-    /**
-     * Creates a new component.
-     * @param options Value indicating whether this component uses a shadow root.
-     */
-    constructor(options = {}) {
-        super();
-        this.#useShadowRoot = options.shadowRoot ?? false;
-    }
-    /**
-     * Returns the node into which this component should render.
-     * @returns The node into which this component should render.
-     */
-    createRenderRoot() {
-        return this.#useShadowRoot ? super.createRenderRoot() : this;
-    }
-}

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

@@ -1 +0,0 @@
-{"version":3,"file":"LoadingIndicator.d.ts","sourceRoot":"","sources":["../../src/Client/UI/LoadingIndicator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,oCAAoC,CAAC;AAE1E;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAY,YAAW,iBAAiB;;IAc7E;;OAEG;IACH,KAAK,IAAI,IAAI;IAMb;;;OAGG;IACH,IAAI,CAAC,OAAO,GAAE;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAM,GAAG,IAAI;CAQ3C;AAED;;GAEG;AACH,OAAO,CAAC,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,qBAAqB;QAC9B,mBAAmB,EAAE,gBAAgB,CAAC;KACtC;CACD"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"MenuActivator.d.ts","sourceRoot":"","sources":["../../src/Client/UI/MenuActivator.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAS7C;;OAEG;IACH,iBAAiB,IAAI,IAAI;CAQzB;AAED;;GAEG;AACH,OAAO,CAAC,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,qBAAqB;QAC9B,gBAAgB,EAAE,aAAa,CAAC;KAChC;CACD"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"OfflineIndicator.d.ts","sourceRoot":"","sources":["../../src/Client/UI/OfflineIndicator.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAEhD;;OAEG;;IAaH;;OAEG;IACH,iBAAiB,IAAI,IAAI;IAIzB;;OAEG;IACH,oBAAoB,IAAI,IAAI;IAI5B;;OAEG;IACH,WAAW,IAAI,IAAI;CAGnB;AAED;;GAEG;AACH,OAAO,CAAC,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,qBAAqB;QAC9B,mBAAmB,EAAE,gBAAgB,CAAC;KACtC;CACD"}

package/lib/UI/ThemeDropdown.d.ts

@@ -1,40 +0,0 @@
-import { AppTheme } from "#Html/AppTheme.js";
-/**
- * A dropdown menu for switching the application theme.
- */
-export declare class ThemeDropdown extends HTMLElement {
-    #private;
-    /**
-     * Creates a new theme dropdown.
-     */
-    constructor();
-    /**
-     * The current application theme.
-     */
-    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;
-}
-/**
- * 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

@@ -1 +0,0 @@
-{"version":3,"file":"ThemeDropdown.d.ts","sourceRoot":"","sources":["../../src/Client/UI/ThemeDropdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAU,MAAM,mBAAmB,CAAC;AAEpD;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;;IAiB7C;;OAEG;;IAeH;;OAEG;IACH,IAAI,KAAK,IAAI,QAAQ,CAEpB;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,QAAQ,EAGxB;IAED;;OAEG;IACH,iBAAiB,IAAI,IAAI;IAKzB;;OAEG;IACH,oBAAoB,IAAI,IAAI;IAI5B;;OAEG;IACH,WAAW,IAAI,IAAI;CAsBnB;AAED;;GAEG;AACH,OAAO,CAAC,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,qBAAqB;QAC9B,gBAAgB,EAAE,aAAa,CAAC;KAChC;CACD"}

package/lib/UI/ThemeDropdown.js

@@ -1,80 +0,0 @@
-import { AppTheme, getIcon } from "#Html/AppTheme.js";
-/**
- * A dropdown menu for switching the application theme.
- */
-export class ThemeDropdown extends HTMLElement {
-    /**
-     * The media query used to check the application theme.
-     */
-    #mediaQuery = matchMedia("(prefers-color-scheme: dark)");
-    /**
-     * The key of the storage entry providing the saved theme mode.
-     */
-    #storageKey = this.getAttribute("storageKey") ?? "AppTheme";
-    /**
-     * The current application theme.
-     */
-    #theme;
-    /**
-     * Creates a new theme dropdown.
-     */
-    constructor() {
-        super();
-        const theme = localStorage.getItem(this.#storageKey);
-        this.#theme = Object.values(AppTheme).includes(theme) ? theme : AppTheme.System;
-        for (const button of this.querySelectorAll("button"))
-            button.addEventListener("click", this.#setTheme.bind(this));
-    }
-    /**
-     * Registers the component.
-     */
-    static {
-        customElements.define("theme-dropdown", this);
-    }
-    /**
-     * The current application theme.
-     */
-    get theme() {
-        return this.#theme;
-    }
-    set theme(value) {
-        localStorage.setItem(this.#storageKey, this.#theme = value);
-        this.#applyTheme();
-    }
-    /**
-     * Method invoked when this component is connected.
-     */
-    connectedCallback() {
-        this.#mediaQuery.addEventListener("change", this);
-        this.#applyTheme();
-    }
-    /**
-     * Method invoked when this component is disconnected.
-     */
-    disconnectedCallback() {
-        this.#mediaQuery.removeEventListener("change", this);
-    }
-    /**
-     * Handles the events.
-     */
-    handleEvent() {
-        this.#applyTheme();
-    }
-    /**
-     * Applies the theme to the document.
-     */
-    #applyTheme() {
-        const theme = this.#theme == AppTheme.System ? (this.#mediaQuery.matches ? AppTheme.Dark : AppTheme.Light) : this.#theme;
-        document.documentElement.dataset.bsTheme = theme.toLowerCase();
-        this.querySelector(".dropdown-toggle > .icon").textContent = getIcon(this.#theme);
-        this.querySelector(`button[data-theme="${this.#theme}"]`).appendChild(this.querySelector(".dropdown-item > .icon"));
-    }
-    /**
-     * Changes the current theme.
-     * @param event The dispatched event.
-     */
-    #setTheme(event) {
-        const button = event.target.closest("button");
-        this.theme = button.dataset.theme;
-    }
-}

package/src/Client/Abstractions/ILoadingIndicator.ts

@@ -1,16 +0,0 @@
-/**
- * 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/DependencyInjection/Container.ts

@@ -1,75 +0,0 @@
-/**
- * Provides a dependency container.
- */
-export class Container {
-
-	/**
-	 * The registered factories.
-	 */
-	readonly #factories = new Map<ContainerToken, () => any>;
-
-	/**
-	 * The registered services.
-	 */
-	readonly #services = new Map<ContainerToken, any>;
-
-	/**
-	 * Removes the service registered with the specified identifier.
-	 * @param id The identification token.
-	 */
-	delete(id: ContainerToken): void {
-		this.#factories.delete(id);
-		this.#services.delete(id);
-	}
-
-	/**
-	 * Gets the service registered with the specified identifier.
-	 * @param id The identification token.
-	 * @returns The instance of the service registered with the specified identifier.
-	 * @throws `Error` if there is no factory registered with the specified identifier.
-	 */
-	get<T>(id: ContainerToken): T { // eslint-disable-line @typescript-eslint/no-unnecessary-type-parameters
-		if (!this.#services.has(id))
-			if (this.#factories.has(id)) this.set(id, this.#factories.get(id)!.call(this));
-			else if (typeof id == "function") this.set(id, Reflect.construct(id, []));
-			else throw Error("There is no factory registered with the specified identifier.");
-
-		return this.#services.get(id) as T;
-	}
-
-	/**
-	 * Gets a value indicating whether this container has a service registered with the specified identifier.
-	 * @param id The identification token.
-	 * @returns `true` if a service registered with the specified identifier exists in this container, otherwise `false`.
-	 */
-	has(id: ContainerToken): boolean {
-		return this.#factories.has(id) || this.#services.has(id);
-	}
-
-	/**
-	 * Registers a service factory with this container.
-	 * @param id The identification token.
-	 * @param factory The service factory.
-	 * @returns This instance.
-	 */
-	register(id: ContainerToken, factory: () => unknown): this {
-		this.#factories.set(id, factory);
-		return this;
-	}
-
-	/**
-	 * Registers a service instance with this container.
-	 * @param id The identification token.
-	 * @param service The service instance.
-	 * @returns This instance.
-	 */
-	set(id: ContainerToken, service: unknown): this {
-		this.#services.set(id, service);
-		return this;
-	}
-}
-
-/**
- * A token identifying a service.
- */
-export type ContainerToken = string|symbol|(new(...args: any[]) => any);

package/src/Client/Html/tsconfig.json

@@ -1,16 +0,0 @@
-{
-	"extends": "../../../tsconfig.json",
-	"include": ["*.ts"],
-	"compilerOptions": {
-		"composite": true,
-		"declaration": true,
-		"declarationMap": true,
-		"noEmit": false,
-		"outDir": "../../../lib/Html",
-		"rootDir": ".",
-		"tsBuildInfoFile": "../../../var/Html.tsbuildinfo"
-	},
-	"references": [
-		{"path": "../Base/tsconfig.json"}
-	]
-}

package/src/Client/Http/HttpClient.ts

@@ -1,127 +0,0 @@
-import type {ILoadingIndicator} from "#Abstractions/ILoadingIndicator.js";
-import {HttpError} from "./HttpError.js";
-
-/**
- * Performs HTTP requests.
- */
-export class HttpClient {
-
-	/**
-	 * The base URL of the remote service.
-	 */
-	readonly baseUrl: 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.baseUrl = new URL(url.endsWith("/") ? url : `${url}/`);
-		this.#loadingIndicator = options.loadingIndicator ?? (() => document.body.querySelector("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("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("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("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("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("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", "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");
-		}
-
-		const loadingIndicator = this.#loadingIndicator();
-		try {
-			loadingIndicator?.start();
-			const request = new Request(new URL(url, this.baseUrl), {...options, method, headers, body} as RequestInit);
-			const response = await fetch(request);
-			if (!response.ok) throw new HttpError(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;
-}>;

package/src/Client/Http/HttpError.ts

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