@vandenberghinc/volt 1.1.2

package/backend/dist/cjs/splash_screen.d.ts

@@ -0,0 +1,35 @@
+import { Stream } from "./stream.js";
+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;
+    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;
+    });
+    get html(): string;
+    _serve(stream: Stream): void;
+}
+export default SplashScreen;

package/backend/dist/cjs/splash_screen.js

@@ -0,0 +1,152 @@
+"use strict";
+/*
+ * Author: Daan van den Bergh
+ * Copyright: © 2022 - 2024 Daan van den Bergh.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SplashScreen = void 0;
+// ---------------------------------------------------------
+// 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.
+ *
+ *          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
+ */
+class SplashScreen {
+    background;
+    image;
+    loader;
+    style;
+    _html;
+    // Constructor.
+    constructor({ background = null, image = null, loader = true, style = null, }) {
+        // Arguments.
+        this.background = background;
+        this.image = image;
+        this.loader = loader;
+        this.style = style;
+        // Attributes.
+        this._html = undefined;
+    }
+    // Get html.
+    get html() {
+        // Cached.
+        if (this._html !== undefined) {
+            return this._html;
+        }
+        // Initialize html.
+        this._html = `<div id='__volt_splash_screen' style='width: 100vw; height: 100vh; display: flex; align-items: center; justify-content: center; ${this.background == null ? "" : "background: " + this.background}; ${this.style == null ? "" : this.style};'>`;
+        const margin_between_img_and_loader = this.loader && this.image != null && this.image.src != null ? "50px" : null;
+        // Create the image.
+        if (this.image != null && this.image.src != null) {
+            this._html += "" +
+                `<img src='${this.image.src}' alt='${this.image.alt || "Icon"}' ` +
+                `${this.image.width ? "width='" + this.image.width + "'" : ""} ${this.image.height ? "height='" + this.image.height + "'" : ""} ` +
+                `style='${this.image.width ? "width: " + this.image.width + ";" : ""} ${this.image.height ? "height: " + this.image.height + ";" : ""} ` +
+                `${margin_between_img_and_loader ? "margin-bottom: " + margin_between_img_and_loader : ""}; ` +
+                `${this.image.style == null ? "" : this.image.style};'>`;
+        }
+        // Create loader.
+        if (this.loader) {
+            const size = typeof this.loader === 'object' && this.loader.size ? this.loader.size : 60;
+            const color = typeof this.loader === 'object' && this.loader.color ? this.loader.color : "#fff";
+            this._html += "<style>" +
+                ".__volt_splash_screen_loader {" +
+                "  display: inline-block;" +
+                "  position: relative;" +
+                `  width: calc(${size}px / 2);` +
+                `  height: calc(${size}px / 2);` +
+                `  position: absolute; bottom: 50px;` +
+                "}" +
+                ".__volt_splash_screen_loader div {" +
+                "  box-sizing: border-box;" +
+                "  display: block;" +
+                "  position: absolute;" +
+                `  width: calc(${64 / 80 * size}px / 2);` +
+                `  height: calc(${64 / 80 * size}px / 2);` +
+                `  margin: calc(${8 / 80 * size}px / 2);` +
+                `  border: calc(${8 / 80 * size}px / 2) solid ${color};` +
+                "  border-radius: 50%;" +
+                "  animation: __volt_splash_screen_loader 1.2s cubic-bezier(0.5, 0, 0.5, 1) infinite;" +
+                `  border-color: ${color} transparent transparent transparent;` +
+                "}" +
+                ".__volt_splash_screen_loader div:nth-child(1) {" +
+                "  animation-delay: -0.45s;" +
+                "}" +
+                ".__volt_splash_screen_loader div:nth-child(2) {" +
+                "  animation-delay: -0.3s;" +
+                "}" +
+                ".__volt_splash_screen_loader div:nth-child(3) {" +
+                "  animation-delay: -0.15s;" +
+                "}" +
+                "@keyframes __volt_splash_screen_loader {" +
+                "  0% {" +
+                "    transform: rotate(0deg);" +
+                "  }" +
+                "  100% {" +
+                "    transform: rotate(360deg);" +
+                "  }" +
+                "}</style>" +
+                `<div class='__volt_splash_screen_loader'><div></div><div></div><div></div><div></div></div>`;
+        }
+        // Close.
+        this._html += "</div>";
+        // Handler.
+        return this._html;
+    }
+    // Serve a client.
+    _serve(stream) {
+        stream.send({
+            status: 200,
+            headers: { "Content-Type": "text/html" },
+            data: this.html,
+        });
+    }
+}
+exports.SplashScreen = SplashScreen;
+exports.default = SplashScreen;

package/backend/dist/cjs/status.d.ts

@@ -0,0 +1,60 @@
+export declare const Status: {
+    undefined: number;
+    continue: number;
+    switching_protocols: number;
+    early_hints: number;
+    success: number;
+    created: number;
+    accepted: number;
+    no_auth_info: number;
+    no_content: number;
+    reset_content: number;
+    partial_content: number;
+    multiple_choices: number;
+    moved_permanently: number;
+    found: number;
+    see_other: number;
+    not_modified: number;
+    temporary_redirect: number;
+    permanent_redirect: number;
+    bad_request: number;
+    unauthorized: number;
+    payment_required: number;
+    forbidden: number;
+    not_found: number;
+    method_not_allowed: number;
+    not_acceptable: number;
+    proxy_auth_required: number;
+    Requestimeout: number;
+    conflict: number;
+    gone: number;
+    length_required: number;
+    precondition_failed: number;
+    payload_too_large: number;
+    uri_too_large: number;
+    unsupported_media_type: number;
+    range_not_statisfiable: number;
+    expectation_failed: number;
+    imateapot: number;
+    unprocessable_entity: number;
+    too_early: number;
+    upgrade_required: number;
+    precondition_required: number;
+    too_many_requests: number;
+    request_header_fields_too_large: number;
+    unavailable_for_legal_reasons: number;
+    internal_server_error: number;
+    not_implemented: number;
+    bad_gateway: number;
+    service_unvailable: number;
+    gateway_timeout: number;
+    http_version_not_supported: number;
+    variant_also_negotiates: number;
+    insufficient_storage: number;
+    loop_detected: number;
+    not_extended: number;
+    network_auth_required: number;
+    two_factor_auth_required: number;
+    get_description(status: number): string;
+};
+export default Status;

package/backend/dist/cjs/status.js

@@ -0,0 +1,199 @@
+"use strict";
+/*
+ * Author: Daan van den Bergh
+ * Copyright: © 2022 - 2024 Daan van den Bergh.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Status = void 0;
+// HTTP response status.
+// - Does not include all status codes.
+/* 	@docs:
+ *	@nav: Backend
+ * 	@chapter: Server
+ * 	@title: Status
+ * 	@description: HTTP status codes.
+ * 	@usage:
+ * 		#include <vlib/sockets/http.h>
+ * 		short success = vlib::http::status::success;
+ * 	@show_code: true
+ */
+exports.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) {
+        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}`;
+        }
+    }
+};
+exports.default = exports.Status;

package/backend/dist/cjs/stream.d.ts

@@ -0,0 +1,75 @@
+import { IncomingMessage, ServerResponse } from 'http';
+import { ServerHttp2Stream, IncomingHttpHeaders, Http2ServerRequest, Http2ServerResponse } from 'http2';
+export type Params = any;
+export type Parameters = Params;
+export declare class Stream {
+    private s?;
+    headers: IncomingHttpHeaders | IncomingMessage['headers'];
+    private req?;
+    private res?;
+    http2: boolean;
+    http1: boolean;
+    private _ip;
+    private _port;
+    private _method;
+    private _params;
+    private _is_query_params;
+    private _endpoint;
+    private _query_string;
+    private _cookies;
+    private _uid;
+    status_code: number | null;
+    finished: boolean;
+    private res_cookies;
+    private res_headers;
+    body: string;
+    private promise;
+    constructor(stream?: ServerHttp2Stream, headers?: IncomingHttpHeaders | IncomingMessage['headers'], req?: IncomingMessage | Http2ServerRequest, res?: ServerResponse | Http2ServerResponse);
+    private _recv_body;
+    private _parse_endoint;
+    _parse_params(): Record<string, any> | undefined;
+    private _parse_cookies;
+    join(): Promise<void>;
+    get ip(): string;
+    get port(): number;
+    get method(): string;
+    get endpoint(): string;
+    get params(): Record<string, any>;
+    param<T = any>(name: string, type?: string | string[] | null, def?: any): T;
+    get cookies(): Record<string, any>;
+    get closed(): boolean;
+    get destroyed(): boolean;
+    get uid(): string | null;
+    set uid(value: string | null);
+    send({ status, headers, body, data, compress }?: {
+        status?: number;
+        headers?: Record<string, any>;
+        body?: any;
+        data?: any;
+        compress?: boolean;
+    }): this;
+    success({ status, headers, body, data, compress }?: {
+        status?: number;
+        headers?: Record<string, any>;
+        body?: any;
+        data?: any;
+        compress?: boolean;
+    }): this;
+    error({ status, headers, body, data, compress }?: {
+        status?: number;
+        headers?: Record<string, any>;
+        body?: any;
+        data?: any;
+        compress?: boolean;
+    }): this;
+    set_header(name: string, value: any): this;
+    set_headers(headers?: Record<string, any>): this;
+    remove_header(...names: string[]): this;
+    remove_headers(...names: string[]): this;
+    set_cookie(cookie: string): this;
+    set_cookies(...cookies: string[]): this;
+}
+export type AuthStream = Stream & {
+    get uid(): string;
+};
+export default Stream;