@vandenberghinc/volt 1.1.26 → 1.1.28

package/backend/dist/cjs/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/cjs/{splash_screen.js → backend/src/splash_screen.js}

@@ -27,7 +27,20 @@ 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 }) {
     this.background = background;
     this.image = image;
@@ -35,7 +48,11 @@ class SplashScreen {
     this.style = style;
     this._html = void 0;
   }
-  // Get html.
+  /**
+   * Generate and return the splash screen HTML. Result is cached after the first call.
+   *
+   * @returns The splash screen HTML markup.
+   */
   get html() {
     if (this._html !== void 0) {
       return this._html;
@@ -53,7 +70,11 @@ class SplashScreen {
     this._html += "</div>";
     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/cjs/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/cjs/{status.js → backend/src/status.js}

@@ -18,71 +18,71 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var stdin_exports = {};
 __export(stdin_exports, {
   Status: () => Status,
-  default: () => stdin_default,
   status: () => Status
 });
 module.exports = __toCommonJS(stdin_exports);
-const 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,
-  // Custom statuses.
-  two_factor_auth_required: 418,
-  // i am a teapot, should not be changed, used by volt js.
-  // Get description.
-  get_description(status) {
+var Status;
+(function(Status2) {
+  Status2[Status2["undefined"] = 0] = "undefined";
+  Status2[Status2["continue"] = 100] = "continue";
+  Status2[Status2["switching_protocols"] = 101] = "switching_protocols";
+  Status2[Status2["early_hints"] = 103] = "early_hints";
+  Status2[Status2["success"] = 200] = "success";
+  Status2[Status2["created"] = 201] = "created";
+  Status2[Status2["accepted"] = 202] = "accepted";
+  Status2[Status2["no_auth_info"] = 203] = "no_auth_info";
+  Status2[Status2["no_content"] = 204] = "no_content";
+  Status2[Status2["reset_content"] = 205] = "reset_content";
+  Status2[Status2["partial_content"] = 206] = "partial_content";
+  Status2[Status2["multiple_choices"] = 300] = "multiple_choices";
+  Status2[Status2["moved_permanently"] = 301] = "moved_permanently";
+  Status2[Status2["found"] = 302] = "found";
+  Status2[Status2["see_other"] = 303] = "see_other";
+  Status2[Status2["not_modified"] = 304] = "not_modified";
+  Status2[Status2["temporary_redirect"] = 307] = "temporary_redirect";
+  Status2[Status2["permanent_redirect"] = 308] = "permanent_redirect";
+  Status2[Status2["bad_request"] = 400] = "bad_request";
+  Status2[Status2["unauthorized"] = 401] = "unauthorized";
+  Status2[Status2["payment_required"] = 402] = "payment_required";
+  Status2[Status2["forbidden"] = 403] = "forbidden";
+  Status2[Status2["not_found"] = 404] = "not_found";
+  Status2[Status2["method_not_allowed"] = 405] = "method_not_allowed";
+  Status2[Status2["not_acceptable"] = 406] = "not_acceptable";
+  Status2[Status2["proxy_auth_required"] = 407] = "proxy_auth_required";
+  Status2[Status2["Requestimeout"] = 408] = "Requestimeout";
+  Status2[Status2["conflict"] = 409] = "conflict";
+  Status2[Status2["gone"] = 410] = "gone";
+  Status2[Status2["length_required"] = 411] = "length_required";
+  Status2[Status2["precondition_failed"] = 412] = "precondition_failed";
+  Status2[Status2["payload_too_large"] = 413] = "payload_too_large";
+  Status2[Status2["uri_too_large"] = 414] = "uri_too_large";
+  Status2[Status2["unsupported_media_type"] = 415] = "unsupported_media_type";
+  Status2[Status2["range_not_statisfiable"] = 416] = "range_not_statisfiable";
+  Status2[Status2["expectation_failed"] = 417] = "expectation_failed";
+  Status2[Status2["imateapot"] = 418] = "imateapot";
+  Status2[Status2["unprocessable_entity"] = 422] = "unprocessable_entity";
+  Status2[Status2["too_early"] = 425] = "too_early";
+  Status2[Status2["upgrade_required"] = 426] = "upgrade_required";
+  Status2[Status2["precondition_required"] = 428] = "precondition_required";
+  Status2[Status2["too_many_requests"] = 429] = "too_many_requests";
+  Status2[Status2["request_header_fields_too_large"] = 431] = "request_header_fields_too_large";
+  Status2[Status2["unavailable_for_legal_reasons"] = 451] = "unavailable_for_legal_reasons";
+  Status2[Status2["internal_server_error"] = 500] = "internal_server_error";
+  Status2[Status2["not_implemented"] = 501] = "not_implemented";
+  Status2[Status2["bad_gateway"] = 502] = "bad_gateway";
+  Status2[Status2["service_unvailable"] = 503] = "service_unvailable";
+  Status2[Status2["gateway_timeout"] = 504] = "gateway_timeout";
+  Status2[Status2["http_version_not_supported"] = 505] = "http_version_not_supported";
+  Status2[Status2["variant_also_negotiates"] = 506] = "variant_also_negotiates";
+  Status2[Status2["insufficient_storage"] = 507] = "insufficient_storage";
+  Status2[Status2["loop_detected"] = 508] = "loop_detected";
+  Status2[Status2["not_extended"] = 510] = "not_extended";
+  Status2[Status2["network_auth_required"] = 511] = "network_auth_required";
+  Status2[Status2["two_factor_auth_required"] = 418] = "two_factor_auth_required";
+})(Status || (Status = {}));
+;
+(function(Status2) {
+  function get_description(status) {
     switch (status) {
       case 0:
         return "Undefined";
@@ -202,8 +202,8 @@ const Status = {
         return `Unknown Status ${status}`;
     }
   }
-};
-var stdin_default = Status;
+  Status2.get_description = get_description;
+})(Status || (Status = {}));
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Status,