@vandenberghinc/volt 1.1.4 → 1.1.6

package/backend/src/endpoint.ts

@@ -11,11 +11,12 @@ import zlib from 'zlib';
 import { View } from './view.js';
 import { vlib } from "@vinc";
 import { vhighlight } from "@vinc";
-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, RateLimitGroup } from "./rate_limit.js";
 import { Stream, AuthStream, Params } from "./stream.js";
+import type { Server } from "./server.js";
 
 const log_source = new LogSource("Endpoint")
 
@@ -24,17 +25,17 @@ const log_source = new LogSource("Endpoint")
 
 type EndpointCallback = ((stream: Stream, params: Params) => any) | ((stream: AuthStream, params: Params) => any);
 
-export interface EndpointOptions {
+interface BaseEndpointOptions {
     method?: string,
     endpoint: string | RegExp,
     authenticated?: boolean,
     rate_limit?: string | RateLimitGroup | RateLimitGroup[] | null,
     params?: Record<string, any> | null,
     callback?: EndpointCallback,
-    view?: View | Record<string, any> | null,
+    // view?: View | Record<string, any> | null,
     data?: any,
-    content_type?: string,
-    compress?: boolean,
+    // content_type: string,
+    compress?: "auto" | boolean,
     cache?: boolean | number,
     ip_whitelist?: string[] | null,
     sitemap?: boolean | null,
@@ -43,6 +44,15 @@ export interface EndpointOptions {
     _path?: string | null,
     _is_static?: boolean,
 }
+interface EndpointOptionsWithView extends Omit<BaseEndpointOptions, "content_type" | "view"> {
+    view: View | Record<string, any>;
+    content_type?: string; // optional when view is provided
+}
+interface EndpointOptionsWithoutView extends BaseEndpointOptions {
+    view?: null | undefined;
+    content_type: string; // required if no view is provided
+}
+export type EndpointOptions = EndpointOptionsWithView | EndpointOptionsWithoutView;
 
 /*  @docs:
  *  @nav: Backend
@@ -149,6 +159,58 @@ class Endpoint {
     // Static attributes.
     static rate_limits: Map<string, any> = new Map();
 
+    static compressed_content_types: string[] = [
+        // 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: string;
     endpoint: string | RegExp;
@@ -156,7 +218,7 @@ class Endpoint {
     params: Record<string, any> | null;
     callback?: EndpointCallback = undefined;
     data: any;
-    content_type: string;
+    content_type?: string;
     compress: boolean;
     cache: boolean | number;
     sitemap: boolean | null;
@@ -174,6 +236,9 @@ class Endpoint {
     content_length?: number;
     is_image_endpoint?: boolean;
 
+    _initialized = false;
+    _server: any;
+
     constructor({
         method = "GET",
         endpoint = "/",
@@ -183,8 +248,8 @@ class Endpoint {
         callback = undefined,
         view = null,
         data = null,
-        content_type = "text/plain",
-        compress = true,
+        content_type,// = "text/plain",
+        compress = "auto",
         cache = true,
         ip_whitelist = null,
         sitemap = null,
@@ -192,7 +257,8 @@ class Endpoint {
         _templates = {}, // only used in loading static files.
         _path = null,
         _is_static = false,
-    }: EndpointOptions) {
+        _server,
+    }: EndpointOptions & { _server: Server }) {
         // Attributes.
         this.method = method;
         this.endpoint = endpoint;
@@ -203,7 +269,6 @@ class Endpoint {
         }
         this.data = data;
         this.content_type = content_type;
-        this.compress = compress !== false;
         this.cache = cache;
         this.sitemap = sitemap;
         this.robots = robots;
@@ -227,6 +292,19 @@ class Endpoint {
             this.endpoint = Utils.clean_endpoint(this.endpoint as string);
         }
 
+        // 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;
@@ -269,6 +347,14 @@ 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.
@@ -345,29 +431,34 @@ class Endpoint {
     }
 
     // Initialize.
-    async _initialize(server: any): Promise<void> {
+    async _dynamic_initialize(): Promise < void> {
+        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 as any, {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 as number | boolean; // @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"]);
@@ -391,10 +482,18 @@ 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: any, status_code: number = 200): Promise<void> {
+    async _serve(stream: Stream, status_code: number = 200): Promise<void> {
+        if (!this._initialized) {
+            await this._dynamic_initialize();
+        }
         try {
             // Check IP whitelist.
             if (this.ip_whitelist && !this.ip_whitelist.includes(stream.ip)) {
@@ -433,29 +532,22 @@ class Endpoint {
                 try {
                     let promise;
                     if (this.params != null) {
-                        promise = this.callback(stream, stream.params ?? {});
+                        promise = this.callback(stream as any, stream.params ?? {});
                     } else {
-                        promise = this.callback(stream, {});
+                        promise = this.callback(stream as any, {});
                     }
                     if (promise instanceof Promise) {
                         await promise;
                     }
                 } catch (err: any) {
-                    if (err instanceof FrontendError) { 
-                        let data: Record<string, any> = {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/src/file_watcher.ts

@@ -193,7 +193,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.`);
             }
         })
 
@@ -222,7 +222,7 @@ class FileWatcher {
             logger.log(2, this.log_source, "Add file watcher exclude", add)
             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.`);
         }
     }
 

package/backend/src/frontend.ts

@@ -15,14 +15,15 @@ export const web_exports = {
 export const Frontend = {
 
 	// Load frontend globals.
-	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();
-	},
+    // @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: {

package/backend/src/image_endpoint.ts

@@ -16,6 +16,7 @@ import { vlib } from "@vinc";
 import { Endpoint } from "./endpoint.js";
 import { logger, LogSource } from "./logger.js";
 import { RateLimitGroup } from "./rate_limit.js";
+import type { Server } from "./server.js";
 
 const log_source = new LogSource("ImageEndpoint")
 
@@ -68,6 +69,7 @@ class ImageEndpoint extends Endpoint implements Endpoint {
         cache = true,
         _is_static = true,
         rate_limit = undefined,
+        _server,
     }: {
         endpoint: string,
         path: vlib.Path,
@@ -75,6 +77,7 @@ class ImageEndpoint extends Endpoint implements Endpoint {
         cache?: boolean | number,
         _is_static?: boolean,
         rate_limit?: string | RateLimitGroup,
+        _server: Server,
     }) {
         // Initialize base.
         super({
@@ -92,6 +95,7 @@ class ImageEndpoint extends Endpoint implements Endpoint {
             rate_limit,
             _path: path.str(),
             _is_static,
+            _server,
         })
 
         // Attributes.

package/backend/src/payments/paddle.ts

@@ -12,7 +12,7 @@ import blobstream from 'blob-stream';
 
 
 import { vlib } from "@vinc";
-import { Utils, FrontendError } from "../utils.js";
+import { Utils, APIError } from "../utils.js";
 import { logger } from "../logger.js";
 import { Status } from "../status.js";
 
@@ -732,7 +732,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,
@@ -2318,7 +2322,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,
+            });
         }
     }
 

package/backend/src/plugins/css.ts

@@ -8,12 +8,13 @@
 
 import CleanCSS from 'clean-css';
 import { vlib } from "@vinc";
+import { log } from 'console';
 
 // ---------------------------------------------------------
 // CSS utils.
 
 // Implementation
-export class CSS {
+export namespace CSS {
     
     /*  @docs:
         @nav: Backend
@@ -28,7 +29,7 @@ export class CSS {
             @descr: The css data.
             @type: string
      */
-    static minify(data: string): string {
+    export function minify(data: string): string {
         return new CleanCSS().minify(data).styles;
     }
 
@@ -48,20 +49,25 @@ export class CSS {
             @descr: The css data.
             @type: string
      */
-    static async bundle({
-        data = "",
+    export async function bundle({
+        data,
         paths = undefined,
         minify = false,
         output = undefined,
+        postprocess = undefined,
+        log_level = 0,
     }: {
         data: string;
         paths?: string[];
         minify?: boolean;
-        output?: string;
+        output?: string | string[];
+        postprocess?: undefined | ((data: string) => string | Promise<string>);
+        log_level?: number;
     }): Promise<string> {
 
         // Load via paths.
         if (paths !== undefined) {
+            data = "";
             for (const path of paths) {
                 (data as string) += await new vlib.Path(path).load();
             }
@@ -72,13 +78,35 @@ export class CSS {
             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 as string;
     }
-}
-export default CSS;
+}

package/backend/src/plugins/ts/compiler.ts

@@ -781,7 +781,7 @@ export interface BundleOptions {
     include?: string[],
 
     // Output path.
-    output?: string,
+    output?: string | string[],
 
     // @deprecated Additional entry paths.
     entry_paths?: string[],
@@ -820,6 +820,9 @@ export interface BundleOptions {
      */
     tree_shaking?: boolean;
 
+    /** External library names not to be included in the bundle */
+    externals?: string[];
+
     /**
      * Enable or disable debug console statements.
      */
@@ -841,6 +844,12 @@ export interface BundleOptions {
 
     // Any other esbuild.bundle options.
     opts?: any;
+
+    // Post process the bundled code.
+    postprocess?: undefined | ((data: string) => string | Promise<string>);
+
+    /** Log level (default is 0) */
+    log_level?: number;
 }
 
 /**
@@ -924,6 +933,7 @@ export async function bundle(options: BundleOptions): Promise<BundleResult> {
     let {
         entry_paths = [],
         include = [],
+        externals = [],
         output = undefined,
         platform = 'browser',
         format = 'iife',
@@ -936,6 +946,8 @@ export async function bundle(options: BundleOptions): Promise<BundleResult> {
         debug = false,
         bundler = "esbuild",
         opts = {},
+        postprocess = undefined,
+        log_level = 0,
         // bundler = "rollup",
     } = options;
     if (entry_paths.length > 0) {
@@ -967,6 +979,7 @@ export async function bundle(options: BundleOptions): Promise<BundleResult> {
                 // minifyWhitespace: false,
                 // minifySyntax: false,
                 // minifyIdentifiers: false,
+                external: externals,
                 ...opts,
             });
             if (result.errors.length > 0) {
@@ -1115,9 +1128,32 @@ export async function bundle(options: BundleOptions): Promise<BundleResult> {
         }
     }
 
+    // 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 {

package/backend/src/plugins/ts/preprocessing.ts

@@ -562,9 +562,11 @@ function detect_unused_imports(source_file: ts.SourceFile): string[] {
 
 	// Load volt exports.
 	if (volt_exports === undefined) {
-		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"];
+        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.