@vandenberghinc/volt 1.1.4 → 1.1.6

package/backend/dist/esm/endpoint.js

@@ -8,7 +8,7 @@ import CleanCSS from 'clean-css';
 import zlib from 'zlib';
 import { View } from './view.js';
 import { vlib } from "./vinc.js";
-import { Utils, FrontendError } from "./utils.js";
+import { Utils, APIError } from "./utils.js";
 import { Status } from "./status.js";
 import { logger, LogSource } from "./logger.js";
 import { RateLimits } from "./rate_limit.js";
@@ -117,6 +117,57 @@ const log_source = new LogSource("Endpoint");
 class Endpoint {
     // Static attributes.
     static rate_limits = new Map();
+    static compressed_content_types = [
+        // Image formats (often already compressed)
+        "image/jpeg",
+        "image/png",
+        "image/gif",
+        "image/webp",
+        "image/bmp",
+        "image/tiff",
+        "image/vnd.microsoft.icon", // ICO
+        // Audio formats (usually compressed)
+        "audio/mpeg", // MP3
+        "audio/mp3",
+        "audio/ogg",
+        "audio/wav",
+        "audio/x-wav",
+        "audio/flac",
+        "audio/aac",
+        "audio/midi",
+        // Video formats (typically compressed)
+        "video/mp4",
+        "video/mpeg",
+        "video/ogg",
+        "video/webm",
+        "video/x-msvideo", // AVI
+        "video/quicktime", // MOV
+        // Archive / Compressed file formats
+        "application/zip",
+        "application/x-7z-compressed",
+        "application/x-rar-compressed",
+        "application/x-tar",
+        "application/gzip",
+        "application/x-gzip",
+        "application/x-bzip",
+        "application/x-bzip2",
+        "application/x-xz",
+        // Documents that are usually compressed internally
+        "application/pdf",
+        "application/vnd.ms-powerpoint",
+        "application/vnd.openxmlformats-officedocument.presentationml.presentation",
+        "application/vnd.ms-excel",
+        "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+        "application/msword",
+        "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+        // Font files
+        "font/woff",
+        "font/woff2",
+        "application/font-sfnt",
+        "application/vnd.ms-fontobject",
+        // Other binary data
+        "application/octet-stream",
+    ];
     // Instance attributes
     method;
     endpoint;
@@ -141,8 +192,11 @@ class Endpoint {
     raw_data;
     content_length;
     is_image_endpoint;
-    constructor({ method = "GET", endpoint = "/", authenticated = false, rate_limit = null, params = null, callback = undefined, view = null, data = null, content_type = "text/plain", compress = true, cache = true, ip_whitelist = null, sitemap = null, robots = null, _templates = {}, // only used in loading static files.
-    _path = null, _is_static = false, }) {
+    _initialized = false;
+    _server;
+    constructor({ method = "GET", endpoint = "/", authenticated = false, rate_limit = null, params = null, callback = undefined, view = null, data = null, content_type, // = "text/plain",
+    compress = "auto", cache = true, ip_whitelist = null, sitemap = null, robots = null, _templates = {}, // only used in loading static files.
+    _path = null, _is_static = false, _server, }) {
         // Attributes.
         this.method = method;
         this.endpoint = endpoint;
@@ -153,7 +207,6 @@ class Endpoint {
         }
         this.data = data;
         this.content_type = content_type;
-        this.compress = compress !== false;
         this.cache = cache;
         this.sitemap = sitemap;
         this.robots = robots;
@@ -174,6 +227,19 @@ class Endpoint {
         if (typeof this.endpoint === "string") {
             this.endpoint = Utils.clean_endpoint(this.endpoint);
         }
+        // Set compress.
+        if (compress === "auto" || typeof compress !== "boolean") {
+            compress = Endpoint.compressed_content_types.includes(this.content_type ?? "");
+        }
+        else if (compress === true && this.content_type != null && Endpoint.compressed_content_types.includes(this.content_type)) {
+            logger.warn(1, log_source, `Overriding parameter "compress", disabling compression of endpoint ${this.endpoint}.`);
+            compress = false;
+        }
+        this.compress = compress;
+        this.compress = false;
+        if (this.compress) {
+            console.log(">>> compress", { endpoint: this.endpoint, content_type: this.content_type });
+        }
         // Argument `view` may also be passed as an object instead of class View.
         if (view == null) {
             this.view = null;
@@ -215,6 +281,12 @@ class Endpoint {
         }
         // The endpoint parent for params verification.
         this._verify_params_parent = this.method + ":" + this.endpoint + ":";
+        // Initialize.
+        this._server = _server;
+        // Initialize html.
+        if (this.view != null) {
+            this.view._initialize(_server, this);
+        }
     }
     // Load data by path.
     _load_data_by_path(server) {
@@ -279,28 +351,33 @@ class Endpoint {
         }
     }
     // Initialize.
-    async _initialize(server) {
+    async _dynamic_initialize() {
+        if (!this._server) {
+            throw new Error(`Endpoint "${this.method}:${this.endpoint}" is not initialized by the server yet.`);
+        }
         // Build html code of view.
         if (this.view != null) {
-            this.view._initialize(server, this);
             await this.view._build_html();
         }
         // Compression enabled.
-        if (server.production && this.callback == null && this.compress) {
+        if (this._server.production && this.callback == null && this.compress) {
             this._is_compressed = true;
             if (this.data != null) {
                 this.raw_data = this.data;
                 this.data = zlib.gzipSync(this.data, { level: zlib.constants.Z_BEST_COMPRESSION });
+                this.content_length = this.data.length;
             }
             else if (this.view != null) {
                 this.view.raw_html = this.view.html;
                 this.view.html = zlib.gzipSync(this.view.html, { level: zlib.constants.Z_BEST_COMPRESSION });
+                this.content_length = this.view.html.length;
             }
+            console.log(">>> Compressed - content_length:", this.content_length);
         }
         // Set cache headers.
-        if (!server.production) {
-            this.cache = false;
-        }
+        // if (!this._server.production) {
+        this.cache = false; // @todo @tmp
+        // }
         if ((this.callback == null || this.is_image_endpoint) && (typeof this.cache === "number" || this.cache === true)) {
             if (this.cache === 1 || this.cache === true) {
                 this.headers.push(["Cache-Control", "max-age=86400"]);
@@ -322,9 +399,16 @@ class Endpoint {
         if (this.content_type != null) {
             this.headers.push(["Content-Type", this.content_type]);
         }
+        if (this._is_compressed) {
+            console.log("Compressed headers:", this.headers);
+        }
+        this._initialized = true;
     }
     // Serve a client.
     async _serve(stream, status_code = 200) {
+        if (!this._initialized) {
+            await this._dynamic_initialize();
+        }
         try {
             // Check IP whitelist.
             if (this.ip_whitelist && !this.ip_whitelist.includes(stream.ip)) {
@@ -371,22 +455,15 @@ class Endpoint {
                     }
                 }
                 catch (err) {
-                    if (err instanceof FrontendError) {
-                        let data = { error: err.message != null ? err.message : "Internal Server Error" };
-                        if (err.data != null && typeof err.data === "object") {
-                            Object.assign(data, err.data);
-                        }
-                        stream.send({
-                            status: err.status != null ? err.status : Status.internal_server_error,
-                            headers: { "Content-Type": "application/json" },
-                            data,
-                        });
+                    if (err instanceof APIError) {
+                        err.serve(stream);
                     }
                     else {
-                        stream.send({
+                        stream.error({
                             status: Status.internal_server_error,
                             headers: { "Content-Type": "application/json" },
-                            data: { error: "Internal Server Error" },
+                            message: "Internal Server Error",
+                            type: "InternalServerError",
                         });
                     }
                     logger.error(log_source, `${this.method}:${this.endpoint}: `, err); // after sending the response since this edits the error.

package/backend/dist/esm/file_watcher.js

@@ -159,7 +159,7 @@ class FileWatcher {
         // Check if the excluded paths exist for user mistakes, these happen often.
         this.excluded.forEach(path => {
             if (!new vlib.Path(path).exists()) {
-                logger.warn(0, this.log_source, `Excluded file watcher path ${path} does not exist.`);
+                logger.warn(1, this.log_source, `Excluded file watcher path ${path} does not exist.`);
             }
         });
         // Attributes.
@@ -187,7 +187,7 @@ class FileWatcher {
             this.excluded.push(add);
         }
         catch (e) {
-            logger.warn(0, this.log_source, `Excluded file watcher path ${path.toString()} does not exist.`);
+            logger.warn(1, this.log_source, `Excluded file watcher path ${path.toString()} does not exist.`);
         }
     }
     // Start.

package/backend/dist/esm/frontend.d.ts

@@ -3,8 +3,6 @@ export declare const web_exports: {
     js: string;
 };
 export declare const Frontend: {
-    load_globals(): Promise<string[]>;
-    load_globals_sync(): string[];
     css: {
         adyen: string;
         volt: string;

package/backend/dist/esm/frontend.js

@@ -1,4 +1,3 @@
-import { vlib } from "./vinc.js";
 // Get the directory name of the current module
 import { fileURLToPath } from 'url';
 import { dirname } from 'path';
@@ -10,14 +9,15 @@ export const web_exports = {
 };
 export const Frontend = {
     // Load frontend globals.
-    async load_globals() {
-        const data = await (new vlib.Path(`${__dirname}/../../../frontend/exports.json`).load());
-        return Object.values(data).flat();
-    },
-    load_globals_sync() {
-        const data = new vlib.Path(`${__dirname}/../../../frontend/exports.json`).load_sync();
-        return Object.values(data).flat();
-    },
+    // @deprecated
+    // async load_globals(): Promise<string[]> {
+    // 	const data: { [key: string]: string[] } = await (new vlib.Path(`${__dirname}/../../../frontend/exports.json`).load());
+    // 	return Object.values(data).flat();
+    // },
+    // load_globals_sync(): string[] {
+    // 	const data: { [key: string]: string[] } = new vlib.Path(`${__dirname}/../../../frontend/exports.json`).load_sync();
+    // 	return Object.values(data).flat();
+    // },
     // Path to css files.
     css: {
         adyen: __dirname + "../../../../frontend/src/css/adyen.css",

package/backend/dist/esm/image_endpoint.d.ts

@@ -1,6 +1,7 @@
 import { vlib } from "./vinc.js";
 import { Endpoint } from "./endpoint.js";
 import { RateLimitGroup } from "./rate_limit.js";
+import type { Server } from "./server.js";
 declare class ImageEndpoint extends Endpoint implements Endpoint {
     static cache_in_memory: boolean;
     static supported_images: string[];
@@ -9,13 +10,14 @@ declare class ImageEndpoint extends Endpoint implements Endpoint {
     private i_data?;
     private i_cache;
     is_image_endpoint: boolean;
-    constructor({ endpoint, path, content_type, cache, _is_static, rate_limit, }: {
+    constructor({ endpoint, path, content_type, cache, _is_static, rate_limit, _server, }: {
         endpoint: string;
         path: vlib.Path;
         content_type: string;
         cache?: boolean | number;
         _is_static?: boolean;
         rate_limit?: string | RateLimitGroup;
+        _server: Server;
     });
     transform(type?: string | null, width?: number | string | null, height?: number | string | null, aspect_ratio?: string | boolean | null): Promise<Buffer>;
     get_aspect_ratio(): Promise<string | null>;

package/backend/dist/esm/image_endpoint.js

@@ -45,7 +45,7 @@ class ImageEndpoint extends Endpoint {
     i_data;
     i_cache;
     is_image_endpoint;
-    constructor({ endpoint, path, content_type, cache = true, _is_static = true, rate_limit = undefined, }) {
+    constructor({ endpoint, path, content_type, cache = true, _is_static = true, rate_limit = undefined, _server, }) {
         // Initialize base.
         super({
             method: "GET",
@@ -62,6 +62,7 @@ class ImageEndpoint extends Endpoint {
             rate_limit,
             _path: path.str(),
             _is_static,
+            _server,
         });
         // Attributes.
         this.i_path = path.abs();

package/backend/dist/esm/payments/paddle.js

@@ -8,7 +8,7 @@ import * as PDFDocument from "pdfkit";
 import * as libcrypto from "crypto";
 import blobstream from 'blob-stream';
 import { vlib } from "../vinc.js";
-import { Utils, FrontendError } from "../utils.js";
+import { Utils, APIError } from "../utils.js";
 import { logger } from "../logger.js";
 import { Status } from "../status.js";
 const log_source = logger.LogSource("Payments");
@@ -585,7 +585,11 @@ export class Paddle {
         }
         // Cancel.
         if (subscription.status !== "active") {
-            throw new FrontendError(`This subscription does not contain any cancellable items, the subscription is likely already cancelled.`, Status.bad_request);
+            throw new APIError({
+                type: "NoActiveSubscriptionError",
+                message: `This subscription is already cancelled and will become inactive at the end of the billing period.`,
+                status: Status.bad_request,
+            });
         }
         await this._req("POST", `/subscriptions/${subscription.id}/cancel`, {
             effective_from: immediate ? "immediately" : null,
@@ -1947,7 +1951,11 @@ export class Paddle {
             }
         });
         if (_throw_no_cancelled_err && cancelled.length === 0) {
-            throw new FrontendError("No cancellable subscriptions found.", Status.bad_request);
+            throw new APIError({
+                type: "NoCancellableSubscriptions",
+                message: "No cancellable subscriptions found.",
+                status: Status.bad_request,
+            });
         }
     }
     // Cancel subscription by subscription id.

package/backend/dist/esm/plugins/css.d.ts

@@ -1,10 +1,11 @@
-export declare class CSS {
-    static minify(data: string): string;
-    static bundle({ data, paths, minify, output, }: {
+export declare namespace CSS {
+    function minify(data: string): string;
+    function bundle({ data, paths, minify, output, postprocess, log_level, }: {
         data: string;
         paths?: string[];
         minify?: boolean;
-        output?: string;
+        output?: string | string[];
+        postprocess?: undefined | ((data: string) => string | Promise<string>);
+        log_level?: number;
     }): Promise<string>;
 }
-export default CSS;

package/backend/dist/esm/plugins/css.js

@@ -9,7 +9,8 @@ import { vlib } from "../vinc.js";
 // ---------------------------------------------------------
 // CSS utils.
 // Implementation
-export class CSS {
+export var CSS;
+(function (CSS) {
     /*  @docs:
         @nav: Backend
         @title: Minify
@@ -23,9 +24,10 @@ export class CSS {
             @descr: The css data.
             @type: string
      */
-    static minify(data) {
+    function minify(data) {
         return new CleanCSS().minify(data).styles;
     }
+    CSS.minify = minify;
     /*  @docs:
         @nav: Backend
         @title: Bundle
@@ -42,9 +44,10 @@ export class CSS {
             @descr: The css data.
             @type: string
      */
-    static async bundle({ data = "", paths = undefined, minify = false, output = undefined, }) {
+    async function bundle({ data, paths = undefined, minify = false, output = undefined, postprocess = undefined, log_level = 0, }) {
         // Load via paths.
         if (paths !== undefined) {
+            data = "";
             for (const path of paths) {
                 data += await new vlib.Path(path).load();
             }
@@ -53,12 +56,35 @@ export class CSS {
         if (minify) {
             data = CSS.minify(data);
         }
+        // Postprocess.
+        if (typeof postprocess === "function") {
+            const res = postprocess(data);
+            if (res instanceof Promise) {
+                data = await res;
+            }
+            else {
+                data = res;
+            }
+        }
         // Save.
-        if (output) {
+        if (typeof output === "string") {
             await new vlib.Path(output).save(data);
         }
+        else if (Array.isArray(output)) {
+            for (let i = 0; i < output.length; i++) {
+                await new vlib.Path(output[i]).save(data);
+            }
+        }
+        // Logs.
+        if (log_level >= 1) {
+            const first_path = typeof output === "string" ? output : (Array.isArray(output) ? output[0] : undefined);
+            if (first_path != null) {
+                const p = new vlib.Path(first_path);
+                vlib.Utils.print_marker(`Bundled ${p.name()} (${p.str()}) [${vlib.Utils.format_bytes(p.size)}].`);
+            }
+        }
         // Return.
         return data;
     }
-}
-export default CSS;
+    CSS.bundle = bundle;
+})(CSS || (CSS = {}));

package/backend/dist/esm/plugins/ts/compiler.d.ts

@@ -60,7 +60,7 @@ export declare function compile(options: CompileOptions): Promise<CompileResult>
  */
 export interface BundleOptions {
     include?: string[];
-    output?: string;
+    output?: string | string[];
     entry_paths?: string[];
     error_limit?: number;
     /**
@@ -85,6 +85,8 @@ export interface BundleOptions {
      * Enable or disable tree shaking.
      */
     tree_shaking?: boolean;
+    /** External library names not to be included in the bundle */
+    externals?: string[];
     /**
      * Enable or disable debug console statements.
      */
@@ -100,6 +102,9 @@ export interface BundleOptions {
      */
     bundler?: 'esbuild' | 'rollup';
     opts?: any;
+    postprocess?: undefined | ((data: string) => string | Promise<string>);
+    /** Log level (default is 0) */
+    log_level?: number;
 }
 /**
  * Result of the bundling process.

package/backend/dist/esm/plugins/ts/compiler.js

@@ -617,8 +617,8 @@ const format_esbuild_warning_error = (warning) => {
  */
 export async function bundle(options) {
     // console.log(">>> BUNDLE", options)
-    let { entry_paths = [], include = [], output = undefined, platform = 'browser', format = 'iife', target = 'es2021', minify = false, sourcemap = false, // 'inline'
-    error_limit = 25, extract_inputs = false, tree_shaking = undefined, debug = false, bundler = "esbuild", opts = {},
+    let { entry_paths = [], include = [], externals = [], output = undefined, platform = 'browser', format = 'iife', target = 'es2021', minify = false, sourcemap = false, // 'inline'
+    error_limit = 25, extract_inputs = false, tree_shaking = undefined, debug = false, bundler = "esbuild", opts = {}, postprocess = undefined, log_level = 0,
     // bundler = "rollup",
      } = options;
     if (entry_paths.length > 0) {
@@ -648,6 +648,7 @@ export async function bundle(options) {
                 // minifyWhitespace: false,
                 // minifySyntax: false,
                 // minifyIdentifiers: false,
+                external: externals,
                 ...opts,
             });
             if (result.errors.length > 0) {
@@ -783,10 +784,33 @@ export async function bundle(options) {
             // throw new Error(`Rollup bundling failed: ${err.message || err}`);
         }
     }
+    // Postprocess.
+    if (bundled_code && typeof postprocess === "function") {
+        const res = postprocess(bundled_code);
+        if (res instanceof Promise) {
+            bundled_code = await res;
+        }
+        else {
+            bundled_code = res;
+        }
+    }
     // Write to file.
     if (typeof output === "string") {
         await new vlib.Path(output).save(bundled_code ?? "");
     }
+    else if (Array.isArray(output)) {
+        for (let i = 0; i < output.length; i++) {
+            await new vlib.Path(output[i]).save(bundled_code ?? "");
+        }
+    }
+    // Logs.
+    if (log_level >= 1) {
+        const first_path = typeof output === "string" ? output : (Array.isArray(output) ? output[0] : undefined);
+        if (first_path != null) {
+            const p = new vlib.Path(first_path);
+            vlib.Utils.print_marker(`Bundled ${p.name()} (${p.str()}) [${vlib.Utils.format_bytes(p.size)}].`);
+        }
+    }
     return {
         code: bundled_code,
         source_map: bundled_source_map,

package/backend/dist/esm/plugins/ts/preprocessing.js

@@ -498,9 +498,11 @@ let volt_exports = undefined;
 function detect_unused_imports(source_file) {
     // Load volt exports.
     if (volt_exports === undefined) {
-        volt_exports = new vlib.Path(`${__dirname}/../../../../../frontend/exports.json`).load_sync({ type: "object" });
-        volt_exports["ui/ui.ts"] = ["VoltUI"];
-        volt_exports["volt.ts"] = ["Volt"];
+        volt_exports = {};
+        // @deprecated.
+        // volt_exports = new vlib.Path(`${__dirname}/../../../../../frontend/exports.json`).load_sync({type: "object"}) as Record<string, string[]>;
+        // volt_exports["ui/ui.ts"] = ["VoltUI"];
+        // volt_exports["volt.ts"] = ["Volt"];
     }
     // Vars.
     // const source_file = ts.createSourceFile(file_path, file_content, ts.ScriptTarget.Latest, true);

package/backend/dist/esm/server.d.ts

@@ -7,13 +7,12 @@ import * as Mail from './plugins/mail.js';
 import { Status } from "./status.js";
 import { Endpoint, EndpointOptions } from "./endpoint.js";
 import { Database, Collection } from "./database.js";
-import { StaticFileWatcher, FileWatcher } from "./file_watcher.js";
+import { /*StaticFileWatcher,*/ FileWatcher } from "./file_watcher.js";
 import { Users } from "./users.js";
 import { Paddle } from "./payments/paddle.js";
 import { RateLimits, RateLimitServer, RateLimitClient } from "./rate_limit.js";
 import { Blacklist } from "./blacklist.js";
 import logger, { LogSource } from "./logger.js";
-import { BrowserPreview } from "./plugins/browser.js";
 declare global {
     type none = null | undefined;
 }
@@ -110,6 +109,7 @@ export declare class Server {
     token_expiration: number;
     google_tag?: string;
     production: boolean;
+    localhost: boolean;
     multiprocessing: boolean;
     processes: number;
     company: CompanyInfo;
@@ -122,8 +122,7 @@ export declare class Server {
     log_level: number;
     tls?: TLSConfig;
     file_watcher?: FileWatcher;
-    admin: AdminConfig;
-    ts: TypeScriptConfig;
+    lightweight: boolean;
     performance: vlib.Performance;
     csp: Record<string, string>;
     default_headers: Record<string, string>;
@@ -142,8 +141,6 @@ export declare class Server {
     keys: Record<string, string>;
     private _on_start;
     private _on_stop;
-    browser_preview?: BrowserPreview;
-    static_file_watcher: StaticFileWatcher;
     is_file_watcher: boolean;
     daemon?: vlib.Daemon;
     private _stop_tscompiler_watcher?;
@@ -152,7 +149,7 @@ export declare class Server {
     status: typeof Status;
     rate_limits: typeof RateLimits;
     logger: typeof logger;
-    constructor({ ip, port, domain, is_primary, source, database, statics, favicon, company, meta, tls, smtp, mail_style, rate_limit, keys, payments, default_headers, google_tag, token_expiration, enable_2fa, enable_account_activation, production, multiprocessing, processes, file_watcher, offline, additional_sitemap_endpoints, log_level, daemon, admin, ts, browser_preview, }: {
+    constructor({ ip, port, domain, is_primary, source, database, statics, favicon, company, meta, tls, smtp, mail_style, rate_limit, keys, payments, default_headers, google_tag, token_expiration, enable_2fa, enable_account_activation, production, localhost, multiprocessing, processes, file_watcher, offline, additional_sitemap_endpoints, log_level, daemon, lightweight, }: {
         ip?: string;
         port?: number;
         domain: string;
@@ -166,7 +163,7 @@ export declare class Server {
         tls?: TLSConfig;
         smtp?: nodemailer.TransportOptions;
         mail_style?: Partial<MailStyle>;
-        rate_limit?: RateLimitConfig;
+        rate_limit?: false | RateLimitConfig;
         keys?: Array<string | {
             name: string;
             length: number;
@@ -178,6 +175,7 @@ export declare class Server {
         enable_2fa?: boolean;
         enable_account_activation?: boolean;
         production?: boolean;
+        localhost?: boolean;
         multiprocessing?: boolean;
         processes?: number | null;
         file_watcher?: FileWatcher | Record<string, any> | boolean;
@@ -185,9 +183,7 @@ export declare class Server {
         additional_sitemap_endpoints?: string[];
         log_level?: number;
         daemon?: Record<string, any> | boolean;
-        admin?: Partial<AdminConfig>;
-        ts?: Partial<TypeScriptConfig>;
-        browser_preview?: string;
+        lightweight?: boolean;
     });
     get_content_type(extension: string): string;
     set_log_level(level: number): void;
@@ -201,9 +197,7 @@ export declare class Server {
     private _create_default_endpoints;
     private _create_sitemap;
     private _create_robots_txt;
-    private _create_admin_endpoint;
     private _initialize_statics;
-    _init_ts(): Promise<void>;
     initialize(): Promise<void>;
     _serve(http2_stream?: http2.ServerHttp2Stream, headers?: Record<string, string>, req?: http.IncomingMessage | http2.Http2ServerRequest, res?: http.ServerResponse | http2.Http2ServerResponse): Promise<void>;
     start(): Promise<void>;