@vandenberghinc/volt 1.1.26 → 1.1.28

package/backend/dist/esm/backend/src/splash_screen.d.ts

@@ -0,0 +1,80 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
+ */
+import { Stream } from "./stream.js";
+/**
+ * The splash screen that can be used on the `View` class.
+ *
+ * @param background The background color of the splash screen.
+ * @param image The image settings. When left undefined, no image will be shown.
+ * @param image.src The image source.
+ * @param image.width The image width in pixels as a number.
+ * @param image.height The image height in pixels as a number.
+ * @param image.style The CSS style for the image element.
+ * @param loader The loader settings. When left undefined, no loader will be shown.
+ *
+ * No loader will be shown when the loader is `null` or `false`. When the loader is `true` or the type is `object` the loader will always be shown. Multiple options can be defined to customize the loader.
+ * @param loader.color The color of the loader.
+ * @param loader.size The loader size in pixels as a number.
+ * @param style The CSS style to add to the main element of the splash screen.
+ * @docs
+ */
+export declare class SplashScreen {
+    background: string | null;
+    image: {
+        src: string;
+        width?: number;
+        height?: number;
+        style?: string | null;
+        alt?: string;
+    } | null;
+    loader: boolean | {
+        color?: string;
+        size?: number;
+    } | null;
+    style: string | null;
+    _html: string | undefined;
+    /**
+     * Create a new splash screen configuration.
+     *
+     * @param background The background color of the splash screen.
+     * @param image The image settings. When left undefined, no image will be shown.
+     * @param image.src The image source.
+     * @param image.width The image width in pixels as a number.
+     * @param image.height The image height in pixels as a number.
+     * @param image.style The CSS style for the image element.
+     * @param loader The loader settings. When left undefined, no loader will be shown.
+     * @param loader.color The color of the loader.
+     * @param loader.size The loader size in pixels as a number.
+     * @param style The CSS style to add to the main element of the splash screen.
+     */
+    constructor({ background, image, loader, style, }: {
+        background?: string | null;
+        image?: {
+            src: string;
+            width?: number;
+            height?: number;
+            style?: string | null;
+            alt?: string;
+        } | null;
+        loader?: boolean | {
+            color?: string;
+            size?: number;
+        } | null;
+        style?: string | null;
+    });
+    /**
+     * Generate and return the splash screen HTML. Result is cached after the first call.
+     *
+     * @returns The splash screen HTML markup.
+     */
+    get html(): string;
+    /**
+     * Serve the splash screen HTML to a client over the provided stream.
+     *
+     * @param stream The stream used to send the HTTP response.
+     */
+    _serve(stream: Stream): void;
+}
+export default SplashScreen;

package/backend/dist/esm/{splash_screen.js → backend/src/splash_screen.js}

@@ -1,58 +1,24 @@
-/*
- * Author: Daan van den Bergh
- * Copyright: © 2022 - 2024 Daan van den Bergh.
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
  */
 // ---------------------------------------------------------
-// Splash screen.
-/*  @docs:
- *  @nav: Backend
- *  @chapter: Endpoints
- *  @title: Splash screen
- *  @description: The splash screen that can be used on the `View` class.
- *  @parameter:
- *      @name: background
- *      @description: The background color of the splash screen.
- *      @type: null, string
- *  @parameter:
- *      @name: image
- *      @description: The image settings. When left undefined, no image will be shown.
- *      @type: null, object
- *      @attr:
- *          @name: src
- *          @description: The image source.
- *          @type: string
- *          @required: true
- *      @attr:
- *          @name: width
- *          @description: The image width in pixels as a number.
- *          @type: number
- *      @attr:
- *          @name: height
- *          @description: The image height in pixels as a number.
- *          @type: number
- *      @attr:
- *          @name: style
- *          @description: The CSS style to for the image element.
- *          @type: null, string
- *  @parameter:
- *      @name: loader
- *      @description:
- *          The loader settings. When left undefined, no loader will be shown.
+/**
+ * The splash screen that can be used on the `View` class.
  *
- *          No loader will be shown when the loader is `null` or `false`. When the loader is `true` or the type is `object` the loader will always be shown. Multiple options can be defined to customize the loader.
- *      @type: null, boolean, object
- *      @attr:
- *          @name: color
- *          @description: The color of the loader.
- *          @type: string
- *      @attr:
- *          @name: size
- *          @description: The loader size in pixels as a number.
- *          @type: number
- *  @parameter:
- *      @name: style
- *      @description: The CSS style to add the main element of the splash screen.
- *      @type: null, string
+ * @param background The background color of the splash screen.
+ * @param image The image settings. When left undefined, no image will be shown.
+ * @param image.src The image source.
+ * @param image.width The image width in pixels as a number.
+ * @param image.height The image height in pixels as a number.
+ * @param image.style The CSS style for the image element.
+ * @param loader The loader settings. When left undefined, no loader will be shown.
+ *
+ * No loader will be shown when the loader is `null` or `false`. When the loader is `true` or the type is `object` the loader will always be shown. Multiple options can be defined to customize the loader.
+ * @param loader.color The color of the loader.
+ * @param loader.size The loader size in pixels as a number.
+ * @param style The CSS style to add to the main element of the splash screen.
+ * @docs
  */
 export class SplashScreen {
     background;
@@ -60,7 +26,20 @@ export class SplashScreen {
     loader;
     style;
     _html;
-    // Constructor.
+    /**
+     * Create a new splash screen configuration.
+     *
+     * @param background The background color of the splash screen.
+     * @param image The image settings. When left undefined, no image will be shown.
+     * @param image.src The image source.
+     * @param image.width The image width in pixels as a number.
+     * @param image.height The image height in pixels as a number.
+     * @param image.style The CSS style for the image element.
+     * @param loader The loader settings. When left undefined, no loader will be shown.
+     * @param loader.color The color of the loader.
+     * @param loader.size The loader size in pixels as a number.
+     * @param style The CSS style to add to the main element of the splash screen.
+     */
     constructor({ background = null, image = null, loader = true, style = null, }) {
         // Arguments.
         this.background = background;
@@ -70,7 +49,11 @@ export class SplashScreen {
         // Attributes.
         this._html = undefined;
     }
-    // Get html.
+    /**
+     * Generate and return the splash screen HTML. Result is cached after the first call.
+     *
+     * @returns The splash screen HTML markup.
+     */
     get html() {
         // Cached.
         if (this._html !== undefined) {
@@ -136,7 +119,11 @@ export class SplashScreen {
         // Handler.
         return this._html;
     }
-    // Serve a client.
+    /**
+     * Serve the splash screen HTML to a client over the provided stream.
+     *
+     * @param stream The stream used to send the HTTP response.
+     */
     _serve(stream) {
         stream.send({
             status: 200,

package/backend/dist/esm/backend/src/status.d.ts

@@ -0,0 +1,74 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
+ */
+/**
+ * HTTP status codes.
+ * @example
+ * 	#include <vlib/sockets/http.h>
+ * 	short success = vlib::http::status::success;
+ * @nav Backend/Server
+ * @docs
+ */
+export declare enum Status {
+    undefined = 0,
+    continue = 100,
+    switching_protocols = 101,
+    early_hints = 103,
+    success = 200,
+    created = 201,
+    accepted = 202,
+    no_auth_info = 203,
+    no_content = 204,
+    reset_content = 205,
+    partial_content = 206,
+    multiple_choices = 300,
+    moved_permanently = 301,
+    found = 302,
+    see_other = 303,
+    not_modified = 304,
+    temporary_redirect = 307,
+    permanent_redirect = 308,
+    bad_request = 400,
+    unauthorized = 401,
+    payment_required = 402,
+    forbidden = 403,
+    not_found = 404,
+    method_not_allowed = 405,
+    not_acceptable = 406,
+    proxy_auth_required = 407,
+    Requestimeout = 408,
+    conflict = 409,
+    gone = 410,
+    length_required = 411,
+    precondition_failed = 412,
+    payload_too_large = 413,
+    uri_too_large = 414,
+    unsupported_media_type = 415,
+    range_not_statisfiable = 416,
+    expectation_failed = 417,
+    imateapot = 418,
+    unprocessable_entity = 422,
+    too_early = 425,
+    upgrade_required = 426,
+    precondition_required = 428,
+    too_many_requests = 429,
+    request_header_fields_too_large = 431,
+    unavailable_for_legal_reasons = 451,
+    internal_server_error = 500,
+    not_implemented = 501,
+    bad_gateway = 502,
+    service_unvailable = 503,
+    gateway_timeout = 504,
+    http_version_not_supported = 505,
+    variant_also_negotiates = 506,
+    insufficient_storage = 507,
+    loop_detected = 508,
+    not_extended = 510,
+    network_auth_required = 511,
+    two_factor_auth_required = 418
+}
+export declare namespace Status {
+    function get_description(status: number | "unknown"): string;
+}
+export { Status as status };

package/backend/dist/esm/backend/src/status.js

@@ -0,0 +1,199 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
+ */
+// HTTP response status.
+// - Does not include all status codes.
+/**
+ * HTTP status codes.
+ * @example
+ * 	#include <vlib/sockets/http.h>
+ * 	short success = vlib::http::status::success;
+ * @nav Backend/Server
+ * @docs
+ */
+export var Status;
+(function (Status) {
+    Status[Status["undefined"] = 0] = "undefined";
+    Status[Status["continue"] = 100] = "continue";
+    Status[Status["switching_protocols"] = 101] = "switching_protocols";
+    Status[Status["early_hints"] = 103] = "early_hints";
+    Status[Status["success"] = 200] = "success";
+    Status[Status["created"] = 201] = "created";
+    Status[Status["accepted"] = 202] = "accepted";
+    Status[Status["no_auth_info"] = 203] = "no_auth_info";
+    Status[Status["no_content"] = 204] = "no_content";
+    Status[Status["reset_content"] = 205] = "reset_content";
+    Status[Status["partial_content"] = 206] = "partial_content";
+    Status[Status["multiple_choices"] = 300] = "multiple_choices";
+    Status[Status["moved_permanently"] = 301] = "moved_permanently";
+    Status[Status["found"] = 302] = "found";
+    Status[Status["see_other"] = 303] = "see_other";
+    Status[Status["not_modified"] = 304] = "not_modified";
+    Status[Status["temporary_redirect"] = 307] = "temporary_redirect";
+    Status[Status["permanent_redirect"] = 308] = "permanent_redirect";
+    Status[Status["bad_request"] = 400] = "bad_request";
+    Status[Status["unauthorized"] = 401] = "unauthorized";
+    Status[Status["payment_required"] = 402] = "payment_required";
+    Status[Status["forbidden"] = 403] = "forbidden";
+    Status[Status["not_found"] = 404] = "not_found";
+    Status[Status["method_not_allowed"] = 405] = "method_not_allowed";
+    Status[Status["not_acceptable"] = 406] = "not_acceptable";
+    Status[Status["proxy_auth_required"] = 407] = "proxy_auth_required";
+    Status[Status["Requestimeout"] = 408] = "Requestimeout";
+    Status[Status["conflict"] = 409] = "conflict";
+    Status[Status["gone"] = 410] = "gone";
+    Status[Status["length_required"] = 411] = "length_required";
+    Status[Status["precondition_failed"] = 412] = "precondition_failed";
+    Status[Status["payload_too_large"] = 413] = "payload_too_large";
+    Status[Status["uri_too_large"] = 414] = "uri_too_large";
+    Status[Status["unsupported_media_type"] = 415] = "unsupported_media_type";
+    Status[Status["range_not_statisfiable"] = 416] = "range_not_statisfiable";
+    Status[Status["expectation_failed"] = 417] = "expectation_failed";
+    Status[Status["imateapot"] = 418] = "imateapot";
+    Status[Status["unprocessable_entity"] = 422] = "unprocessable_entity";
+    Status[Status["too_early"] = 425] = "too_early";
+    Status[Status["upgrade_required"] = 426] = "upgrade_required";
+    Status[Status["precondition_required"] = 428] = "precondition_required";
+    Status[Status["too_many_requests"] = 429] = "too_many_requests";
+    Status[Status["request_header_fields_too_large"] = 431] = "request_header_fields_too_large";
+    Status[Status["unavailable_for_legal_reasons"] = 451] = "unavailable_for_legal_reasons";
+    Status[Status["internal_server_error"] = 500] = "internal_server_error";
+    Status[Status["not_implemented"] = 501] = "not_implemented";
+    Status[Status["bad_gateway"] = 502] = "bad_gateway";
+    Status[Status["service_unvailable"] = 503] = "service_unvailable";
+    Status[Status["gateway_timeout"] = 504] = "gateway_timeout";
+    Status[Status["http_version_not_supported"] = 505] = "http_version_not_supported";
+    Status[Status["variant_also_negotiates"] = 506] = "variant_also_negotiates";
+    Status[Status["insufficient_storage"] = 507] = "insufficient_storage";
+    Status[Status["loop_detected"] = 508] = "loop_detected";
+    Status[Status["not_extended"] = 510] = "not_extended";
+    Status[Status["network_auth_required"] = 511] = "network_auth_required";
+    // Custom statuses.
+    Status[Status["two_factor_auth_required"] = 418] = "two_factor_auth_required";
+})(Status || (Status = {}));
+;
+(function (Status) {
+    // Get description.
+    function get_description(status) {
+        switch (status) {
+            case 0:
+                return "Undefined";
+            case 100:
+                return "Continue";
+            case 101:
+                return "Switching Protocols";
+            case 103:
+                return "Early Hints";
+            case 200:
+                return "OK";
+            case 201:
+                return "Created";
+            case 202:
+                return "Accepted";
+            case 203:
+                return "Non-Authoritative Information";
+            case 204:
+                return "No Content";
+            case 205:
+                return "Reset Content";
+            case 206:
+                return "Partial Content";
+            case 300:
+                return "Multiple Choices";
+            case 301:
+                return "Moved Permanently";
+            case 302:
+                return "Found";
+            case 303:
+                return "See Other";
+            case 304:
+                return "Not Modified";
+            case 307:
+                return "Temporary Redirect";
+            case 308:
+                return "Permanent Redirect";
+            case 400:
+                return "Bad Request";
+            case 401:
+                return "Unauthorized";
+            case 402:
+                return "Payment Required";
+            case 403:
+                return "Forbidden";
+            case 404:
+                return "Not Found";
+            case 405:
+                return "Method Not Allowed";
+            case 406:
+                return "Not Acceptable";
+            case 407:
+                return "Proxy Authentication Required";
+            case 408:
+                return "Request Timeout";
+            case 409:
+                return "Conflict";
+            case 410:
+                return "Gone";
+            case 411:
+                return "Length Required";
+            case 412:
+                return "Precondition Failed";
+            case 413:
+                return "Payload Too Large";
+            case 414:
+                return "URI Too Long";
+            case 415:
+                return "Unsupported Media Type";
+            case 416:
+                return "Range Not Satisfiable";
+            case 417:
+                return "Expectation Failed";
+            // case 418:
+            //     return "I'm a teapot";
+            case 422:
+                return "Unprocessable Entity";
+            case 425:
+                return "Too Early";
+            case 426:
+                return "Upgrade Required";
+            case 428:
+                return "Precondition Required";
+            case 429:
+                return "Too Many Requests";
+            case 431:
+                return "Request Header Fields Too Large";
+            case 451:
+                return "Unavailable For Legal Reasons";
+            case 500:
+                return "Internal Server Error";
+            case 501:
+                return "Not Implemented";
+            case 502:
+                return "Bad Gateway";
+            case 503:
+                return "Service Unavailable";
+            case 504:
+                return "Gateway Timeout";
+            case 505:
+                return "HTTP Version Not Supported";
+            case 506:
+                return "Variant Also Negotiates";
+            case 507:
+                return "Insufficient Storage";
+            case 508:
+                return "Loop Detected";
+            case 510:
+                return "Not Extended";
+            case 511:
+                return "Network Authentication Required";
+            // Custom.
+            case 418:
+                return "Two Factor Auth Required"; // Custom status
+            default:
+                return `Unknown Status ${status}`;
+        }
+    }
+    Status.get_description = get_description;
+})(Status || (Status = {}));
+export { Status as status }; // snake_case compatibility.