@vandenberghinc/volt 1.1.26 → 1.1.28

package/frontend/dist/backend/src/utils.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh.
+ */
+import * as vlib from "@vandenberghinc/vlib";
+export declare namespace Utils {
+    function fill_templates(data: string, templates: Record<string, any>, curly_style?: boolean): string;
+    function get_currency_symbol(currency: string): string | null;
+    function get_compiled_cache(domain: string, method: string, endpoint: string): {
+        cache_path: vlib.Path;
+        cache_hash: any;
+        cache_data: any;
+    };
+    function set_compiled_cache(path: vlib.Path, data: string, hash: string): void;
+}
+export { Utils as utils };

package/frontend/dist/backend/src/utils.js

@@ -0,0 +1,241 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh.
+ */
+// ---------------------------------------------------------
+// Imports.
+import * as vlib from "@vandenberghinc/vlib";
+// ---------------------------------------------------------
+// Utils.
+// Implementation
+export var Utils;
+(function (Utils) {
+    // Fill templates {{TEMPLATE}}
+    function fill_templates(data, templates, curly_style = true) {
+        if (templates == null) {
+            return data;
+        }
+        const keys = Object.keys(templates);
+        // Iterate data.
+        if (keys.length > 0) {
+            for (let i = 0; i < data.length; i++) {
+                // {{TEMPLATE}} Curly style.
+                if (curly_style && data.charAt(i) === "{" && data.charAt(i + 1) === "{") {
+                    // Iterate all templates.  
+                    for (let k = 0; k < keys.length; k++) {
+                        if (data.charAt(i + keys[k].length + 2) === "}" &&
+                            data.charAt(i + keys[k].length + 3) === "}" &&
+                            data.startsWith(keys[k], i + 2)) {
+                            const end_index = i + keys[k].length + 4;
+                            if (templates[keys[k]] != null && typeof templates[keys[k]] === "object") {
+                                data = vlib.String.replace_indices(data, JSON.stringify(templates[keys[k]]), i, end_index);
+                            }
+                            else {
+                                data = vlib.String.replace_indices(data, templates[keys[k]], i, end_index);
+                            }
+                            i = end_index - 1;
+                        }
+                    }
+                }
+                // $TEMPLATE dollar style.
+                else if (!curly_style && data.charAt(i) === "$") {
+                    // Iterate all templates.  
+                    for (let k = 0; k < keys.length; k++) {
+                        if (data.startsWith(keys[k], i + 1)) {
+                            const end_index = i + keys[k].length + 1;
+                            if (templates[keys[k]] != null && typeof templates[keys[k]] === "object") {
+                                data = vlib.String.replace_indices(data, JSON.stringify(templates[keys[k]]), i, end_index);
+                            }
+                            else {
+                                data = vlib.String.replace_indices(data, templates[keys[k]], i, end_index);
+                            }
+                            i = end_index - 1;
+                        }
+                    }
+                }
+            }
+        }
+        // Response.
+        return data;
+    }
+    Utils.fill_templates = fill_templates;
+    // Utils.
+    function get_currency_symbol(currency) {
+        switch (currency.toLowerCase()) {
+            case "aed": return "د.إ";
+            case "afn": return "Af";
+            case "all": return "L";
+            case "amd": return "֏";
+            case "ang": return "ƒ";
+            case "aoa": return "Kz";
+            case "ars": return "$";
+            case "aud": return "$";
+            case "awg": return "ƒ";
+            case "azn": return "₼";
+            case "bam": return "KM";
+            case "bbd": return "Bds$";
+            case "bdt": return "৳";
+            case "bgn": return "лв";
+            case "bhd": return ".د.ب";
+            case "bif": return "FBu";
+            case "bmd": return "BD$";
+            case "bnd": return "B$";
+            case "bob": return "Bs";
+            case "brl": return "R$";
+            case "bsd": return "B$";
+            case "btn": return "Nu.";
+            case "bwp": return "P";
+            case "byn": return "Br";
+            case "bzd": return "BZ$";
+            case "cad": return "$";
+            case "cdf": return "FC";
+            case "chf": return "Fr";
+            case "clf": return "UF";
+            case "clp": return "$";
+            case "cny": return "¥";
+            case "cop": return "$";
+            case "crc": return "₡";
+            case "cuc": return "CUC$";
+            case "cup": return "CUP$";
+            case "cve": return "$";
+            case "czk": return "Kč";
+            case "djf": return "Fdj";
+            case "dkk": return "kr";
+            case "dop": return "RD$";
+            case "dzd": return "دج";
+            case "egp": return "E£";
+            case "ern": return "Nfk";
+            case "etb": return "Br";
+            case "eur": return "€";
+            case "fjd": return "FJ$";
+            case "fkp": return "£";
+            case "fok": return "F$";
+            case "gbp": return "£";
+            case "gel": return "₾";
+            case "ghc": return "₵";
+            case "gip": return "£";
+            case "gmd": return "D";
+            case "gnf": return "FG";
+            case "gtq": return "Q";
+            case "gyd": return "GY$";
+            case "hkd": return "HK$";
+            case "hnl": return "L";
+            case "hrk": return "kn";
+            case "htg": return "G";
+            case "huf": return "Ft";
+            case "idr": return "Rp";
+            case "ils": return "₪";
+            case "inr": return "₹";
+            case "iqd": return "د.ع";
+            case "irr": return "﷼";
+            case "isk": return "kr";
+            case "jmd": return "J$";
+            case "jod": return "JD";
+            case "jpy": return "¥";
+            case "kes": return "Ksh";
+            case "kgs": return "с";
+            case "khr": return "៛";
+            case "kmf": return "CF";
+            case "kpw": return "₩";
+            case "krw": return "₩";
+            case "kwd": return "KD";
+            case "kyd": return "CI$";
+            case "kzt": return "₸";
+            case "lak": return "₭";
+            case "lbp": return "L£";
+            case "lkr": return "Rs";
+            case "lrd": return "L$";
+            case "lsl": return "L";
+            case "lyd": return "ل.د";
+            case "mad": return "د.م.";
+            case "mdl": return "L";
+            case "mnt": return "₮";
+            case "mop": return "MOP$";
+            case "mur": return "Rs";
+            case "mvr": return "Rf";
+            case "mwk": return "MK";
+            case "mxn": return "$";
+            case "myr": return "RM";
+            case "mzn": return "MTn";
+            case "nad": return "N$";
+            case "ngn": return "₦";
+            case "nio": return "C$";
+            case "nok": return "kr";
+            case "npr": return "रू";
+            case "nzd": return "$";
+            case "omr": return "ر.ع.";
+            case "pab": return "B/.";
+            case "pen": return "S/.";
+            case "pgk": return "K";
+            case "php": return "₱";
+            case "pkr": return "Rs";
+            case "pln": return "zł";
+            case "pyg": return "₲";
+            case "qar": return "ر.ق";
+            case "ron": return "lei";
+            case "rsd": return "din.";
+            case "rub": return "₽";
+            case "rwf": return "FRw";
+            case "sar": return "ر.س";
+            case "sbd": return "SI$";
+            case "scr": return "Sr";
+            case "sdg": return "ج.س.";
+            case "sek": return "kr";
+            case "sgd": return "S$";
+            case "shp": return "£";
+            case "sll": return "Le";
+            case "sos": return "S";
+            case "srd": return "SRD$";
+            case "ssp": return "£";
+            case "std": return "Db";
+            case "sek": return "kr";
+            case "syp": return "S£";
+            case "szl": return "L";
+            case "thb": return "฿";
+            case "tjs": return "ЅМ";
+            case "tmt": return "m";
+            case "tnd": return "د.ت";
+            case "top": return "T$";
+            case "try": return "₺";
+            case "ttd": return "TT$";
+            case "twd": return "NT$";
+            case "tzs": return "TSh";
+            case "uah": return "₴";
+            case "ugx": return "USh";
+            case "usd": return "$";
+            case "uyu": return "$U";
+            case "uzs": return "лв";
+            case "ves": return "Bs.S.";
+            case "vnd": return "₫";
+            case "vuv": return "VT";
+            case "wst": return "WS$";
+            case "xaf": return "FCFA";
+            case "xcd": return "EC$";
+            case "xof": return "CFA";
+            case "xpf": return "CFP";
+            case "yer": return "﷼";
+            case "zar": return "R";
+            case "zmw": return "ZK";
+        }
+        return null;
+    }
+    Utils.get_currency_symbol = get_currency_symbol;
+    // Try a compiled js cache using the /tmp/
+    function get_compiled_cache(domain, method, endpoint) {
+        const cache_path = new vlib.Path(`/tmp/${domain.replaceAll("/", "")}:${method}:${endpoint.replaceAll("/", "_")}`);
+        let cache_data, cache_hash;
+        if (cache_path.exists()) {
+            cache_data = cache_path.load_sync();
+            cache_hash = new vlib.Path(cache_path.str() + '.hash').load_sync();
+        }
+        return { cache_path, cache_hash, cache_data };
+    }
+    Utils.get_compiled_cache = get_compiled_cache;
+    // @todo
+    function set_compiled_cache(path, data, hash) {
+        path.save_sync(data);
+        new vlib.Path(path.str() + '.hash').save_sync(hash);
+    }
+    Utils.set_compiled_cache = set_compiled_cache;
+})(Utils || (Utils = {}));
+export { Utils as utils }; // lowercase export for compatibility

package/frontend/dist/backend/src/view.d.ts

@@ -0,0 +1,162 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
+ */
+import * as vlib from "@vandenberghinc/vlib";
+import * as vts from "@vandenberghinc/vlib/vts";
+import { Meta } from "./meta.js";
+import { Endpoint } from "./endpoint.js";
+import { Server } from "./server.js";
+import { SplashScreen } from "./splash_screen.js";
+import Stream from "./stream.js";
+/**
+ * @nav Backend
+ * @chapter Endpoints
+ * @title View
+ * @class
+ *
+ * @param source
+ *   The file path to the client side JavaScript source code.
+ *
+ * @param callback
+ *   The client side callback function; this function will be executed at the client side.
+ *   For this feature the `Content-Security-Policy: script-src` must be updated with, for example, `unsafe-inline`.
+ *
+ * @param includes
+ *   The included static JS files.
+ *
+ *   By default, the local includes will be embedded into the HTML page. However, this behaviour can be disabled by passing an object of type `IncludeObject` with the attribute `embed = false`.
+ *
+ * @param links
+ *   The included static CSS files.
+ *
+ *   By default, the local links will be embedded into the HTML page. However, this behaviour can be disabled by passing an object of type `LinkObject` with the attribute `embed = false`.
+ *
+ * @param templates
+ *   Templates that will replace the `callback` code. Templates can be created using the `$TEMPLATE` template style.
+ *
+ * @warning
+ *   Templates will only be used on the code of the `callback` attribute.
+ *
+ * @param meta
+ *   The meta information object.
+ *
+ * @param jquery
+ *   Include jQuery by default.
+ *
+ * @param body_style
+ *   The style of the `<body>` element. When left undefined, the static attribute `View.body_style` will be used.
+ *
+ * @param splash_screen
+ *   The splash screen settings. When left undefined, the static attribute `View.splash_screen` will be used.
+ *
+ * @param tree_shaking
+ *   Optimize JavaScript source code by removing dead code.
+ *
+ * @param mangle
+ *   Optimize JavaScript source code by mangling function names.
+ *
+ * @param _src
+ *   Internal parameter (ignored).
+ *
+ * @typedef IncludeObject
+ * @property src
+ *   The source URL of the script to include. (required)
+ * @property embed
+ *   When set to `false`, disables embedding the endpoint's content into the HTML page.
+ * @property attributes
+ *   Any other attributes will be assigned to the `<script>` tag.
+ *
+ * @typedef LinkObject
+ * @property href
+ *   The source URL of the link to include. (required)
+ * @property rel
+ *   The `rel` attribute of the link tag.
+ * @property embed
+ *   When set to `false`, disables embedding the endpoint's content into the HTML page.
+ * @property attributes
+ *   Any other attributes will be assigned to the `<link>` tag.
+ *
+ * @static
+ * @memberof View
+ * @member body_style
+ *   The style of the `<body>` element. This static attribute will be used on all Views when defined. However,
+ *   it can be overridden for a single View by defining the parameter.
+ *
+ * @static
+ * @memberof View
+ * @member splash_screen
+ *   The splash screen settings. This static attribute will be used on all Views when defined. However,
+ *   it can be overridden for a single View by defining the parameter.
+ */
+export declare class View {
+    static includes: Array<string | Record<string, any>>;
+    static links: Array<string | Record<string, any>>;
+    static body_style: string | null;
+    static splash_screen: SplashScreen | undefined;
+    private static _volt_css?;
+    private static _vhighlight_css?;
+    source: string | null;
+    source_path?: vlib.Path;
+    callback: Function | null;
+    includes: Array<string | Record<string, any>>;
+    links: Array<string | Record<string, any>>;
+    templates: Record<string, any>;
+    meta: Meta;
+    jquery: boolean;
+    lang: string;
+    body_style: string | null;
+    splash_screen: SplashScreen | undefined;
+    tree_shaking: boolean;
+    mangle: boolean;
+    _src?: string;
+    _embedded_sources: Array<string>;
+    is_js_ts_view: boolean;
+    private _html?;
+    raw_html?: string | Buffer;
+    _bundle?: vts.BundleResult;
+    payments?: string | undefined;
+    min_device_width?: number;
+    server?: Server;
+    endpoint?: Endpoint;
+    constructor({ source, callback, includes, links, templates, meta, jquery, lang, body_style, splash_screen, tree_shaking, mangle, min_device_width, _src, }: {
+        source?: string | null;
+        callback?: Function | null;
+        includes?: (string | Record<string, any>)[];
+        links?: (string | Record<string, any>)[];
+        templates?: Record<string, any>;
+        meta?: Meta;
+        jquery?: boolean;
+        lang?: string;
+        body_style?: string | null;
+        splash_screen?: SplashScreen;
+        tree_shaking?: boolean;
+        mangle?: boolean;
+        min_device_width?: number;
+        _src?: string;
+    });
+    _initialize(server: Server, endpoint: Endpoint): void;
+    private _dynamic_bundle;
+    /** Ensure the view is bundled when required. */
+    ensure_bundle(): Promise<void>;
+    /** Create an error HTML file when errors are encountered during the bundle process. */
+    private _build_bundle_err_html;
+    private _build_html;
+    /** Retrieve the content length of the built html. */
+    content_length(): Promise<number>;
+    /** Retrieve the HTML. */
+    html(opts?: {
+        compress?: boolean;
+    }): Promise<{
+        html: string | Buffer;
+        content_length: number;
+        nonce: string;
+    }>;
+    _serve(stream: Stream, status_code?: number, opts?: {
+        compress?: boolean;
+    }): Promise<void>;
+    private html_nonce_split?;
+}
+export declare namespace View {
+    type Opts = ConstructorParameters<typeof View>[0];
+}