@vandenberghinc/volt 1.2.7 → 1.2.8

package/backend/old/response.deprc.js

@@ -0,0 +1,354 @@
+/*
+ * Author: Daan van den Bergh
+ * Copyright: © 2022 - 2024 Daan van den Bergh.
+ */
+
+// ---------------------------------------------------------
+// Imports.
+
+const zlib = require('zlib');
+
+// ---------------------------------------------------------
+// Response object.
+
+/*  @docs 
+ *  @nav: Backend
+ *  @chapter: Stream
+ *  @title: Response
+ *  @description: The response object.
+ *  @deprecated: true
+ */
+class Response {
+    constructor(res) {
+
+        // Arguments.
+        this.res = res;
+
+        // Attributes.
+        this.cookies = [];
+
+        // Copy default functions.
+        // this.addTrailers = this.res.addTrailers;
+        this.cork = this.res.cork.bind(this.res);
+        this.end = this.res.end.bind(this.res);
+        // this.flushHeaders = this.res.flushHeaders;
+        // this.getHeader = this.res.getHeader;
+        // this.getHeaderNames = this.res.getHeaderNames;
+        // this.getHeaders = this.res.getHeaders;
+        // this.hasHeader = this.res.hasHeader;
+        // this.removeHeader = this.res.removeHeader;
+        // this.setHeader = this.res.setHeader;
+        // this.setTimeout = this.res.setTimeout;
+        this.uncork = this.res.uncork.bind(this.res);
+        this.write = this.res.write.bind(this.res);
+        // this.writeContinue = this.res.writeContinue;
+        // this.writeEarlyHints = this.res.writeEarlyHints;
+        // this.writeHead = this.res.writeHead;
+        // this.writeProcessing = this.res.writeProcessing;
+
+        // Create lowercase functions.
+        this.add_trailers = this.res.addTrailers.bind(this.res);
+        this.flush_headers = this.res.flushHeaders.bind(this.res);
+        this.get_header = this.res.getHeader.bind(this.res);
+        this.get_header_names = this.res.getHeaderNames.bind(this.res);
+        this.get_headers = this.res.getHeaders.bind(this.res);
+        this.has_header = this.res.hasHeader.bind(this.res);
+        this.remove_header = this.res.removeHeader.bind(this.res);
+        this.set_header = this.res.setHeader.bind(this.res);
+        this.set_timeout = this.res.setTimeout;
+        // this.write_continue = this.res.writeContinue;
+        // this.write_early_hints = this.res.writeEarlyHints;
+        // this.write_head = this.res.writeHead;
+        // this.write_processing = this.res.writeProcessing;
+    }
+
+    // ---------------------------------------------------------
+    // Functions.
+
+    // Send a response.
+	/*  @docs:
+     *  @title: Send
+     *  @description: Send a response
+     *  @parameter:
+     *      @name: status
+     *      @description: The response status.
+     *      @type: number
+	 *  @parameter:
+     *      @name: headers
+     *      @description: The response headers.
+     *      @type: object
+	 *  @parameter:
+     *      @name: data
+     *      @description: The response data.
+     *      @type: undefined, string
+	 *  @parameter:
+     *      @name: compress
+     *      @description: A boolean indicating if the response data should be compressed.
+     *      @type: boolean
+     *  @usage:
+     *      ...
+     *      response.send({status: 200, data: "Hello World!"});
+     */
+    send({status = 200, headers = {}, data = null, compress = false} = {}) {
+
+        // Set status code.
+        this.res.statusCode = status;
+
+        // Set headers.
+        Object.keys(headers).forEach((key) => {
+            this.res.setHeader(key, headers[key]);
+        });
+
+        // Set cookies.
+        if (this.cookies.length > 0) {
+            this.res.setHeader('Set-Cookie', this.cookies);
+        }
+
+        // Convert data.
+        let is_json = false;
+        if (data != null && typeof data === 'object' && Buffer.isBuffer(data) === false && (data instanceof Uint8Array) === false) {
+            is_json = true;
+            data = JSON.stringify(data);
+        }
+
+        // @todo compress.
+        if (compress) {
+            this.res.setHeader("Content-Encoding", "gzip");
+            this.res.setHeader("Vary", "Accept-Encoding");
+            data = zlib.gzipSync(data, {level: zlib.constants.Z_BEST_COMPRESSION});
+        }
+
+        // Set data.
+        if (data != null) {
+            if (is_json) {
+                this.res.setHeader("Content-Type", "application/json");
+            }
+            this.res.write(data); // do not use toString() here or it will cause issues with writing binary data.
+        }
+
+        // End.
+        this.res.end();
+    }
+
+    // Send a successs response.
+	/*  @docs:
+     *  @title: Send Successs
+     *  @description: Send a response
+     *  @parameter:
+     *      @name: status
+     *      @description: The response status.
+     *      @type: number
+	 *  @parameter:
+     *      @name: headers
+     *      @description: The response headers.
+     *      @type: object
+	 *  @parameter:
+     *      @name: data
+     *      @description: The response data.
+     *      @type: undefined, string
+	 *  @parameter:
+     *      @name: compress
+     *      @description: A boolean indicating if the response data should be compressed.
+     *      @type: boolean
+     *  @usage:
+     *      ...
+     *      response.success({data: "Hello World!"});
+     */
+    success({status = 200, headers = {}, data = null, compress = false} = {}) {
+        return this.send({status: status, headers: headers, data: data, compress: compress});
+    }
+	
+	// Send an error response.
+	/*  @docs:
+     *  @title: Send Error
+     *  @description: Send an error response
+     *  @parameter:
+     *      @name: status
+     *      @description: The response status.
+     *      @type: number
+	 *  @parameter:
+     *      @name: headers
+     *      @description: The response headers.
+     *      @type: object
+	 *  @parameter:
+     *      @name: data
+     *      @description: The response data.
+     *      @type: undefined, string
+	 *  @parameter:
+     *      @name: compress
+     *      @description: A boolean indicating if the response data should be compressed.
+     *      @type: boolean
+     *  @usage:
+     *      ...
+     *      response.error({data: "Some error occured"});
+     */
+    error({status = 500, headers = {}, data = null, compress = false} = {}) {
+        return this.send({status: status, headers: headers, data: data, compress: compress});
+    }
+
+    // Set headers.
+	/*  @docs:
+     *  @title: Set Headers
+     *  @description: Add new headers to the response data.
+	 *  @parameter:
+     *      @name: headers
+     *      @description: The new response headers.
+     *      @type: object
+     *  @usage:
+     *      ...
+     *      response.set_headers({"Connection": "close"});
+     */
+    set_headers(headers = {}) {
+        if (headers == null) { return null; }
+        Object.keys(headers).forEach((key) => {
+            this.res.setHeader(key, headers[key]);
+        });
+    }
+
+    // Set a cookie.
+	/*  @docs:
+     *  @title: Set cookie.
+     *  @description: Set a cookie that will be sent with the response.
+	 *  @warning: Will only be added to the response when the user uses `send()`, `success()` or `error()`.
+	 *  @parameter:
+     *      @name: cookie
+     *      @description: The cookie string.
+     *      @type: string
+     *  @usage:
+     *      ...
+     *      response.set_cookie("MyCookie=Hello World;");
+     */
+    set_cookie(cookie) {
+        this.cookies.push(cookie);
+    }
+	
+	// Set cookies.
+	/*  @docs:
+     *  @title: Set Cookies
+     *  @description: Set a cookie that will be sent with the response.
+	 *  @warning: Will only be added to the response when the user uses `send()`, `success()` or `error()`.
+	 *  @parameter:
+     *      @name: cookies
+     *      @description: The cookie strings.
+     *      @type: ...string
+     *  @usage:
+     *      ...
+     *      response.set_cookies("MyCookie1=Hello World;", "MyCookie2=Hello Universe;");
+     */
+    set_cookies(cookies) {
+        for (let i = 0; i < cookies.length; i++) {
+            this.cookies.push(cookies[i]);
+        }
+    }
+
+    // ---------------------------------------------------------
+    // Defaults.
+
+    // Create lowercase functions for default getters and setters.
+    get headers_sent() {
+        return this.res.headersSent;
+    }
+    set headers_sent(val) {
+        this.res.headersSent = val;
+    }
+    get send_date() {
+        return this.res.sendDate;
+    }
+    set send_date(val) {
+        this.res.sendDate = val;
+    }
+    get status_code() {
+        return this.res.statusCode;
+    }
+    set status_code(val) {
+        this.res.statusCode = val;
+    }
+    get status_message() {
+        return this.res.statusMessage;
+    }
+    set status_message(val) {
+        this.res.statusMessage = val;
+    }
+    get strict_content_length() {
+        return this.res.strictContentLength;
+    }
+    set strict_content_length(val) {
+        this.res.strictContentLength = val;
+    }
+    get writable_ended() {
+        return this.res.writableEnded;
+    }
+    set writable_ended(val) {
+        this.res.writableEnded = val;
+    }
+    get finished() {
+        return this.res.finished;
+    }
+    get writable_finished() {
+        return this.res.writableFinished;
+    }
+    set writable_finished(val) {
+        this.res.writableFinished = val;
+    }
+
+    // Copy default functions.
+    // get headersSent() {
+    //     return this.res.headersSent;
+    // }
+    // set headersSent() {
+    //     return this.res.headersSent;
+    // }
+    // get req() {
+    //    return this.res.req;
+    // }
+    // set req() {
+    //    return this.res.req; 
+    // }
+    // get sendDate() {
+    //     return this.res.sendDate;
+    // }
+    // set sendDate() {
+    //     return this.res.sendDate;
+    // }
+    // get socket() {
+    //     return this.res.socket;
+    // }
+    // set socket() {
+    //     return this.res.socket;
+    // }
+    // get statusCode() {
+    //     return this.res.statusCode;
+    // }
+    // set statusCode() {
+    //     return this.res.statusCode;
+    // }
+    // get statusMessage() {
+    //     return this.res.statusMessage;
+    // }
+    // set statusMessage() {
+    //     return this.res.statusMessage;
+    // }
+    // get strictContentLength() {
+    //     return this.res.strictContentLength;
+    // }
+    // set strictContentLength() {
+    //     return this.res.strictContentLength;
+    // }
+    // get writableEnded() {
+    //     return this.res.writableEnded;
+    // }
+    // set writableEnded() {
+    //     return this.res.writableEnded;
+    // }
+    // get writableFinished() {
+    //     return this.res.writableFinished;
+    // }
+    // set writableFinished() {
+    //     return this.res.writableFinished;
+    // }
+}
+
+// ---------------------------------------------------------
+// Exports.
+
+module.exports = Response;

package/frontend/examples/theme/theme.ts

@@ -0,0 +1,58 @@
+// @ts-nocheck
+
+// Imports.
+// import * as volt from "@vandenberghinc/volt/frontend";
+
+// ---------------------------------------------------------
+// Themes.	
+
+// Create theme from options.
+const create_theme = (opts: {
+    bg: string;
+    fg: string;
+    primary: string;
+}) => {
+    return {
+        /** 
+         * The relative value for font sizes, and the font size used for paragraphs.
+         * @warning work with a single fixed font size, and base all other font sizes on this font size using `Theme.multiply("font_size", 1.0)`.
+         */
+        font_size: 16,
+
+        /** Code fonts */
+        font: "'Mona Sans', sans-serif",
+        code_font: "'Menlo', 'Consolas', monospace",
+
+        /** Colors */
+        primary: opts.primary,
+        bg: opts.bg,
+        bg_0: opts.bg,
+        bg_1: new volt.Color(opts.bg).auto_darken_lighten(0.02).rgb(),
+        bg_2: new volt.Color(opts.bg).auto_darken_lighten(0.04).rgb(),
+        bg_3: new volt.Color(opts.bg).auto_darken_lighten(0.08).rgb(),
+        bg_hover: new volt.Color(opts.bg).auto_darken_lighten(0.02).rgb(),
+        div_bg: volt.Color.opposite_s(opts.bg).opacity(0.075).rgb(),
+        fg: opts.fg,
+        fg_0: opts.fg,
+        fg_1: new volt.Color(opts.bg).auto_darken_lighten(0.7).rgb(),
+        fg_2: new volt.Color(opts.bg).auto_darken_lighten(0.5).rgb(),
+
+        green: "#60B05B",
+        red: "#CA3140",
+        yellow: "#F1DA6C", //"#FFFC79",
+    }
+}
+
+// Initialize the theme.
+export const Theme = new volt.Theme("my_website", {
+    dark: create_theme({
+        bg: "#0B0E12",
+        fg: "#FFFFFF", // #F0F0F0
+        primary: `linear-gradient(110deg, #00FDF1, rgb(87, 149, 243) 7.5%, #B96593)`,
+    }),
+    light: create_theme({
+        bg: "#F0F0F0",
+        fg: "#0E1D32",
+        primary: `linear-gradient(110deg, #00FDF1, rgb(87, 149, 243) 7.5%, #B96593)`,
+    }),
+}) as volt.ExtendTheme<ReturnType<typeof create_theme>>;

package/frontend/tools/bundle_d_ts.js

@@ -0,0 +1,71 @@
+#!/usr/bin/env node
+/**
+ * Create a single bundle .d.ts file from multiple .d.ts files.
+ */
+
+import fs from 'fs/promises';
+import { glob } from 'glob';
+import { fileURLToPath } from 'url';
+import * as path from 'path';
+import * as vlib from "@vandenberghinc/vlib"
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+async function main() {
+    
+    const target = path.join(__dirname, '..', 'dist/frontend/');
+    const patterns = [target + '/**/*.d.ts'];
+    
+    console.log("Target directory:", target)
+    
+    const create_bundle = async (name = "lml_bundle.d.ts", exclude = undefined) => {
+        exclude ??= [];
+        exclude.push("**/lml_bundle*.d.ts");
+        const files = await glob(patterns, { nodir: true, ignore: exclude });
+        const bundle = [];
+        const out = path.join(target, name);
+        console.log("Creating bundle:", out)
+        const file_sizes = [];
+        for (const file of files) {
+            const rel_path = path.relative(target, file);
+            if (rel_path === name || (exclude != null && exclude.includes(rel_path))) continue; // Skip output file if re-running
+            console.log(" - included", rel_path)
+
+            // Load.
+            let code = await fs.readFile(file, 'utf8');
+
+            // Process `elements/base.d.ts`
+            if (rel_path === 'src/elements/base.d.ts') {
+                // only keep everything before the `extend()` function.
+                code = code.split("export declare function extend<")[0];
+            }
+
+            // Add to file sizes.
+            file_sizes.push({ file: rel_path, size: new vlib.Path(file).size });
+
+            // Add to file.
+            bundle.push(`// ---- ${path.relative(target, file)} ----\n` + code);
+        }
+
+        // Log file sizes
+        file_sizes.sort((a, b) => b.size - a.size);
+        console.log("Biggest files:");
+        for (const fs of file_sizes.slice(0, 10)) {
+            console.log(` - ${vlib.System.format_bytes(fs.size).padStart(10)}  ${fs.file}`);
+        }
+
+        // Write.
+        await fs.writeFile(out, bundle.join('\n\n'), 'utf8');
+        console.log(`Bundled ${files.length} .d.ts files into ${out} with a size of ${vlib.System.format_bytes(new vlib.Path(out).size)}.`);
+    }
+
+    await create_bundle("lml_bundle.d.ts");
+    await create_bundle("lml_bundle.ui.d.ts", ["src/modules/paddle.d.ts"]);
+}
+
+main().catch(err => {
+    console.error(err);
+    process.exit(1);
+});
+