@vandenberghinc/volt 1.1.5 → 1.1.7

package/backend/src/status.ts

@@ -196,4 +196,5 @@ export const Status = {
 	    }
     }
 };
+export { Status as status }; // lowercase export for compatibility
 export default Status;

package/backend/src/stream.ts

@@ -748,6 +748,8 @@ export class Stream {
         compress?: boolean
     } = {}): this {
 
+        compress = false; // @todo @tmp
+
         // Copy body.
         if (data != null) {
             body = data;
@@ -777,14 +779,14 @@ export class Stream {
                 body = JSON.stringify(body);
             }
 
-            // Respond.
-            stream.respond(this.res_headers as any)
-
             // Compress.
             if (compress) {
                 body = zlib.gzipSync(body, {level: zlib.constants.Z_BEST_COMPRESSION});
             }
 
+            // Respond.
+            stream.respond(this.res_headers as any)
+
             // End.
             if (body != null) {
                 stream.end(Buffer.from(body));
@@ -913,14 +915,32 @@ export class Stream {
      *      ...
      *      stream.error({data: "Some error occured"});
      */
-    error({status = 500, headers = {}, body = null, data = null, compress = false}: {
+    error({
+        message,
+        type = "APIError",
+        invalid_fields = {},
+        status = 500,
+        headers = {},
+        compress = false,
+        data = undefined,
+    }: {
+        message: string,
+        type?: string,
+        invalid_fields?: Record<string, string>,
         status?: number,
         headers?: Record<string, any>,
-        body?: any,
-        data?: any,
         compress?: boolean
-    } = {}): this {
-        return this.send({status: status, headers: headers, body: body ?? data, compress: compress});
+        data?: any[] | Record<string, any>,
+    }): this {
+        return this.send({ status: status, headers: headers, compress: compress, body: {
+            error: {
+                type,
+                message,
+                status,
+                invalid_fields,
+            },
+            data,
+        }});
     }
 
     // Set headers.

package/backend/src/users.ts

@@ -11,7 +11,7 @@ import { vhighlight } from "@vinc";
 import * as utils from "./utils.js";
 import * as Mail from "./plugins/mail.js";
 import { Status } from "./status.js";
-const { FrontendError } = utils;
+const { APIError } = utils;
 import { logger } from "./logger.js";
 import { Stream, AuthStream } from "./stream.js"
 import { Server, MailAttachment } from "./server.js"
@@ -319,16 +319,16 @@ export class Users {
     // Initialization (private).
 
     // Initialize.
-    _initialize(): void {
+    async _initialize(): Promise<void> {
 
         // Database collections.
-        this._tokens_db = this.server.db.create_uid_collection("_tokens");
-        this._users_db = this.server.db.create_uid_collection("_users");
+        this._tokens_db = await this.server.db.create_uid_collection("_tokens");
+        this._users_db = await this.server.db.create_uid_collection("_users");
 
         // Public database collections.
-        this.public = this.server.db.create_uid_collection("_users_public");
-        this.protected = this.server.db.create_uid_collection("_users_protected");
-        this.private = this.server.db.create_uid_collection("_users_private");
+        this.public = await this.server.db.create_uid_collection("_users_public");
+        this.protected = await this.server.db.create_uid_collection("_users_protected");
+        this.private = await this.server.db.create_uid_collection("_users_private");
 
         // ---------------------------------------------------------
         // Default auth endpoints.
@@ -391,12 +391,20 @@ export class Users {
                         username_err = err as Error;
                     }
                     if (email_err && username_err) {
-                        return stream.error({ status: Status.bad_request, data: { error: email_err.message } });
+                        return stream.error({
+                            status: Status.bad_request, 
+                            type: "InvalidParams",
+                            message: email_err.message,
+                        });
                     }
                     try {
                         password = stream.param("password");
                     } catch (err) {
-                        return stream.error({ status: Status.bad_request, data: { error: (err as Error).message } });
+                        return stream.error({
+                            status: Status.bad_request, 
+                            type: "InvalidParams",
+                            message: (err as any).message,
+                        });
                     }
 
                     // Get uid.
@@ -404,26 +412,24 @@ export class Users {
                         if ((uid = await this.get_uid_by_email(email)) == null) {
                             return stream.error({
                                 status: Status.unauthorized,
-                                data: {
-                                    error: "Unauthorized.",
-                                    invalid_fields: {
-                                        "email": "Invalid or unrecognized email",
-                                        "password": "Invalid or unrecognized password",
-                                    },
-                                }
+                                type: "Unauthorized",
+                                message: "Unauthorized.",
+                                invalid_fields: {
+                                    "email": "Invalid or unrecognized email",
+                                    "password": "Invalid or unrecognized password",
+                                },
                             });
                         }
                     } else {
                         if ((uid = await this.get_uid(username as string)) == null) {
                             return stream.error({
                                 status: Status.unauthorized,
-                                data: {
-                                    error: "Unauthorized.",
-                                    invalid_fields: {
-                                        "username": "Invalid or unrecognized username",
-                                        "password": "Invalid or unrecognized password",
-                                    },
-                                }
+                                type: "Unauthorized",
+                                message: "Unauthorized.",
+                                invalid_fields: {
+                                    "username": "Invalid or unrecognized username",
+                                    "password": "Invalid or unrecognized password",
+                                },
                             });
                         }
                     }
@@ -539,23 +545,28 @@ export class Users {
                     if (error) {
                         return stream.error({
                             status: Status.bad_request,
-                            data: {
-                                error,
-                                invalid_fields,
-                            }
+                            type: "InvalidParams",
+                            message: error,
+                            invalid_fields: invalid_fields ?? undefined,
                         });
                     }
 
                     // Verify username and email.
                     if (await this.username_exists(params.username)) {
-                        const e = new FrontendError(`Username "${params.username}" is already registered.`);
-                        e.invalid_fields = { "username": "Username is already registered" };
-                        throw e;
+                        throw new APIError({
+                            type: "UsernameAlreadyExists",
+                            message: `Username "${params.username}" is already registered.`,
+                            status: Status.bad_request,
+                            invalid_fields: { "username": "Username is already registered" },
+                        });
                     }
                     if (await this.email_exists(params.email)) {
-                        const e = new FrontendError(`Email "${params.email}" is already registered.`);
-                        e.invalid_fields = { "email": "Email is already registered" };
-                        throw e;
+                        throw new APIError({
+                            type: "EmailAlreadyExists",
+                            message: `Email "${params.email}" is already registered.`,
+                            status: Status.bad_request,
+                            invalid_fields: { "email": "Email is already registered" }
+                        });
                     }
 
                     // Verify 2fa.
@@ -611,10 +622,9 @@ export class Users {
                     } catch (err) {
                         return stream.error({
                             status: Status.bad_request,
-                            data: {
-                                error: (err as Error).message,
-                                invalid_fields: (err as any).invalid_fields || {},
-                            }
+                            type: "InvalidParams",
+                            message: (err as Error).message,
+                            invalid_fields: (err as any).invalid_fields || {},
                         });
                     }
 
@@ -646,7 +656,7 @@ export class Users {
 
                     // Check uid.
                     if (uid == null) {
-                        return stream.error({ status: Status.forbidden, data: { error: "Permission denied." } });
+                        return stream.error({ status: Status.forbidden, message: "Permission denied." });
                     }
 
                     // Verify.
@@ -654,12 +664,10 @@ export class Users {
                     if (err) {
                         return stream.error({
                             status: Status.forbidden,
-                            data: {
-                                error: "Permission denied.",
-                                invalid_fields: {
-                                    "code": err,
-                                },
-                            }
+                            message: "Permission denied.",
+                            invalid_fields: {
+                                "code": err,
+                            },
                         });
                     }
 
@@ -690,17 +698,15 @@ export class Users {
                     if (error) {
                         return stream.error({
                             status: Status.bad_request,
-                            data: {
-                                error: error,
-                                invalid_fields,
-                            }
+                            message: error,
+                            invalid_fields: invalid_fields ?? undefined,
                         });
                     }
 
                     // Get uid.
                     let uid;
                     if ((uid = await this.get_uid_by_email(params.email)) == null) {
-                        return stream.error({ status: Status.forbidden, data: { error: "Invalid email." } });
+                        return stream.error({ status: Status.forbidden, message: "Invalid email." });
                     }
 
                     // Verify 2fa.
@@ -708,12 +714,10 @@ export class Users {
                     if (err) {
                         return stream.error({
                             status: Status.forbidden,
-                            data: {
-                                error: "Invalid 2FA code.",
-                                invalid_fields: {
-                                    "code": "Invalid code"
-                                },
-                            }
+                            message: "Invalid 2FA code.",
+                            invalid_fields: {
+                                "code": "Invalid code"
+                            },
                         });
                     }
 
@@ -765,6 +769,7 @@ export class Users {
             {
                 method: "POST",
                 endpoint: "/volt/user",
+                content_type: "application/json",
                 authenticated: true,
                 rate_limit: "global",
                 callback: async (stream: AuthStream) => {
@@ -778,6 +783,7 @@ export class Users {
             {
                 method: "POST",
                 endpoint: "/volt/user/change_password",
+                content_type: "application/json",
                 authenticated: true,
                 rate_limit: "global",
                 params: {
@@ -790,12 +796,10 @@ export class Users {
                     if (await this.verify_password(stream.uid, params.current_password) !== true) {
                         return stream.error({
                             status: Status.unauthorized,
-                            data: {
-                                error: "Incorrect password.",
-                                invalid_fields: {
-                                    current_password: "Incorrect password.",
-                                }
-                            },
+                            message: "Incorrect password.",
+                            invalid_fields: {
+                                current_password: "Incorrect password.",
+                            }
                         });
                     }
 
@@ -804,10 +808,8 @@ export class Users {
                     if (error) {
                         return stream.error({
                             status: Status.bad_request,
-                            data: {
-                                error: error,
-                                invalid_fields,
-                            }
+                            message: error,
+                            invalid_fields: invalid_fields ?? undefined,
                         });
                     }
 
@@ -826,6 +828,7 @@ export class Users {
             {
                 method: "DELETE",
                 endpoint: "/volt/user",
+                content_type: "application/json",
                 authenticated: true,
                 rate_limit: "global",
                 callback: async (stream: AuthStream) => {
@@ -847,6 +850,7 @@ export class Users {
             {
                 method: "POST",
                 endpoint: "/volt/user/api_key",
+                content_type: "application/json",
                 authenticated: true,
                 rate_limit: "global",
                 callback: async (stream: AuthStream) => {
@@ -863,6 +867,7 @@ export class Users {
             {
                 method: "DELETE",
                 endpoint: "/volt/user/api_key",
+                content_type: "application/json",
                 authenticated: true,
                 rate_limit: "global",
                 callback: async (stream: AuthStream) => {
@@ -878,6 +883,7 @@ export class Users {
             {
                 method: "GET",
                 endpoint: "/volt/user/data",
+                content_type: "application/json",
                 authenticated: true,
                 rate_limit: "global",
                 params: {
@@ -896,6 +902,7 @@ export class Users {
             {
                 method: "POST",
                 endpoint: "/volt/user/data",
+                content_type: "application/json",
                 authenticated: true,
                 rate_limit: "global",
                 params: {
@@ -915,6 +922,7 @@ export class Users {
             {
                 method: "DELETE",
                 endpoint: "/volt/user/data",
+                content_type: "application/json",
                 authenticated: true,
                 rate_limit: "global",
                 params: {
@@ -935,6 +943,7 @@ export class Users {
             {
                 method: "GET",
                 endpoint: "/volt/user/data/protected",
+                content_type: "application/json",
                 authenticated: true,
                 rate_limit: "global",
                 params: {
@@ -995,7 +1004,7 @@ export class Users {
                             first_name = stream.param("first_name");
                             last_name = stream.param("last_name");
                         } catch (err) {
-                            return stream.error({ status: Status.bad_request, data: { error: (err as Error).message } });
+                            return stream.error({ status: Status.bad_request, message: (err as Error).message });
                         }
                     } else {
                         user = await this.get(stream.uid);
@@ -1246,14 +1255,20 @@ export class Users {
         // Check if username & email already exist.
         if (_check_username_email) {
             if (await this.username_exists(username)) {
-                const e = new FrontendError(`Username "${username}" is already registered.`);
-                e.invalid_fields = {"username": "Username is already registered"};
-                throw e;
+                throw new APIError({
+                    type: "UsernameAlreadyExists",
+                    message: `Username "${username}" is already registered.`,
+                    status: Status.bad_request,
+                    invalid_fields: { "username": "Username is already registered" },
+                });
             }
             if (await this.email_exists(email)) {
-                const e = new FrontendError(`Email "${email}" is already registered.`);
-                e.invalid_fields = {"email": "Email is already registered"};
-                throw e;
+                throw new APIError({
+                    type: "EmailAlreadyExists",
+                    message: `Email "${email}" is already registered.`,
+                    status: Status.bad_request,
+                    invalid_fields: { "email": "Email is already registered" }
+                });
             }
         }
 

package/backend/src/utils.ts

@@ -8,10 +8,46 @@
 
 import * as libcrypto from "crypto";
 import { vlib } from "@vinc";
+import { Status } from "./status.js";
+import type { Stream } from "./stream.js";
 
 // ---------------------------------------------------------
 // Utils.
 
+/**
+ * The API error class is used to throw an error that will be presented to the user. All other errors will result in an internal server error response without the error's message.
+ */
+export class APIError extends Error {
+    public type: string;
+    public status: number;
+    public data?: any[] | Record<string, any>;
+    public invalid_fields: Record<string, string>;
+    constructor({ type = "APIError", message, status, data, invalid_fields }: {
+        type?: string,
+        message: string,
+        status?: number,
+        data?: any,
+        invalid_fields?: Record<string, string>,
+    }) {
+        super(message);
+        this.name = "APIError";
+        this.type = type;
+        this.status = status ?? Status.internal_server_error;
+        this.data = data;
+        this.invalid_fields = invalid_fields ?? {};
+    }
+    serve(stream: Stream) {
+        stream.error({
+            status: this.status ?? Status.internal_server_error, 
+            headers: {"Content-Type": "application/json"},
+            message: this.message, 
+            type: this.type,
+            invalid_fields: this.invalid_fields,
+        });
+        return this;
+    }
+}
+
 /*  @docs:
  *  @nav: Backend
     @parent: Utils
@@ -35,21 +71,21 @@ import { vlib } from "@vinc";
         @descr: The error body data.
         @type: any
  */
-export class FrontendError extends Error {
-    public name: string;
-    public status?: number;
-    public data?: any;
-    public invalid_fields: Record<string, string> = {};
-    constructor(message: string, status?: number, data?: any, invalid_fields?: Record<string, string>) {
-        super(message);
-        this.name = "FrontendError";
-        this.status = status;
-        this.data = data;
-        if (invalid_fields !== undefined) {
-            this;invalid_fields = invalid_fields;
-        }
-    }
-}
+// export class FrontendError extends Error {
+//     public name: string;
+//     public status?: number;
+//     public data?: any;
+//     public invalid_fields: Record<string, string> = {};
+//     constructor(message: string, status?: number, data?: any, invalid_fields?: Record<string, string>) {
+//         super(message);
+//         this.name = "FrontendError";
+//         this.status = status;
+//         this.data = data;
+//         if (invalid_fields !== undefined) {
+//             this.invalid_fields = invalid_fields;
+//         }
+//     }
+// }
 
 /*  @docs:
  *  @nav: Backend
@@ -74,16 +110,15 @@ export class FrontendError extends Error {
         @descr: The error body data.
         @type: any
  */
-export class APIError extends FrontendError {
-    constructor(message: string, status?: number, data?: any, invalid_fields?: Record<string, string>) {
-        super(message, status, data, invalid_fields);
-        this.name = "APIError";
-    }
-}
+// export class APIError extends FrontendError {
+//     constructor(message: string, status?: number, data?: any, invalid_fields?: Record<string, string>) {
+//         super(message, status, data, invalid_fields);
+//         this.name = "APIError";
+//     }
+// }
 
 // Define interface with overloads
 interface UtilsInt {
-    "FrontendError": typeof FrontendError;  // Replace with actual type
     "APIError": typeof APIError;  // Replace with actual type
     
     // Overload signatures in interface
@@ -100,9 +135,6 @@ interface UtilsInt {
 // Implementation
 export const Utils: UtilsInt = {
 
-    // An error that may be shown to the frontend user.
-    "FrontendError": FrontendError,
-
     // An error that may be shown to the frontend user.
     "APIError": APIError,
 
@@ -356,4 +388,5 @@ export const Utils: UtilsInt = {
     },
 
 }
+export { Utils as utils }; // lowercase export for compatibility
 export default Utils;

package/backend/src/view.ts

@@ -164,7 +164,7 @@ export class View {
     is_js_ts_view: boolean;
     html?: string | Buffer;
     raw_html?: string | Buffer;
-    bundle: any;
+    _bundle: any;
     payments?: string | undefined;
     // vhighlight?: string | undefined;
     min_device_width?: number;
@@ -245,7 +245,7 @@ export class View {
 
         // Attributes.
         this.html = undefined;
-        this.bundle = undefined;
+        this._bundle = undefined;
     }
 
     // Initialize.
@@ -256,21 +256,22 @@ export class View {
         this._endpoint = endpoint;
     }
 
-    // Bundle the compiled typescript / javascript view.
-    async _bundle_ts(dist_path: string, bundle: any = null): Promise<any> {
+    // Bundle the compiled typescript / javascript dynamically on demand to optimize server startup for development purposes.
+    async _dynamic_bundle() {
+
         // Server & endpoint.
         if (this._server === undefined || this._endpoint === undefined) { throw Error("View has not been initialized with \"View._initialize()\" yet."); }
 
         // Bundle.
-        const had_bundle = this.bundle !== undefined;
-        if (bundle != null) {
-            // also accept already bundled for server.js in case multiple endpoint paths serve the same bundle.
-            this.bundle = bundle;
-        } else {
-            logger.log(2, log_source, `Bundling entry path "${dist_path}".`)
-            this.bundle = await TSCompiler.bundle({
-                entry_paths: [dist_path],
-                minify: this._server.production,
+        // const had_bundle = this.bundle !== undefined;
+        // if (bundle != null) {
+        //     // also accept already bundled for server.js in case multiple endpoint paths serve the same bundle.
+        //     this.bundle = bundle;
+        // } else {
+        logger.log(2, log_source, `Bundling entry path "${this.source_path?.str()}".`)
+            this._bundle = await TSCompiler.bundle({
+                entry_paths: [this.source_path?.str() ?? ""],
+                minify: false,//this._server.production,
                 platform: "browser",
                 // format: "esm",
                 format: "iife",
@@ -278,29 +279,25 @@ export class View {
                 // target: "esnext",
                 // sourcemap: this._server.production ? false : "inline",
                 extract_inputs: true, // since bundle.inputs is used by server.js.
-                tree_shaking: true,
+                tree_shaking: false,
             })
-            if (this.bundle.errors.length > 0) {
+            if (this._bundle.errors.length > 0) {
                 logger.log(0, log_source, `Encountered an error while bundling "${this.source}".`)
-                this.bundle.debug();
+                this._bundle.debug();
                 return;
             }
-        }
+        // }
 
         // Set options based on inputs.
-        this.payments = this.bundle.inputs.find((path: string) => path.endsWith("/modules/paddle.js"));
+        this.payments = this._bundle.inputs.find((path: string) => path.endsWith("/modules/paddle.js"));
         // this.vhighlight = this.bundle.inputs.find((path: string) => path.endsWith("/vhighlight.js"));
 
         // Rebuild html.
         await this._build_html();
-        if (had_bundle) {
-            logger.log(0, log_source, `Refreshing endpoint ${this._endpoint.method}:${this._endpoint.endpoint}.`)
-        } else {
-            logger.log(1, log_source, `Refreshing endpoint ${this._endpoint.method}:${this._endpoint.endpoint}.`)
-        }
+        logger.log(0, log_source, `Bundling javascript endpoint ${this._endpoint.method}:${this._endpoint.endpoint}.`)
 
         // Response.
-        return this.bundle;
+        // return this.bundle;
     }
 
     // Build html.
@@ -308,9 +305,14 @@ export class View {
         // Server & endpoint.
         if (this._server === undefined || this._endpoint === undefined) { throw Error("View has not been initialized with \"View._initialize()\" yet."); }
 
+        // Bundle js files automatically.
+        if (this.is_js_ts_view && !this._bundle) {
+            await this._dynamic_bundle();
+        }
+
         // Vars.
-        const line_break = this._server.production ? "" : "\n";
-        const has_bundle = this.bundle != null && typeof this.bundle === "object";
+        const line_break = this._server.production ? "\n" : "\n";
+        const has_bundle = this._bundle != null && typeof this._bundle === "object";
 
         // Initialize html.
         this.html = "";
@@ -590,8 +592,8 @@ export class View {
         })
 
         // Add direct source code.
-        if (has_bundle && typeof this.bundle.code === "string") {
-            this.html += `<script type='module'>${line_break}${this.bundle.code}${line_break}</script>${line_break}`;
+        if (has_bundle && typeof this._bundle.code === "string") {
+            this.html += `<script type='module'>${line_break}${this._bundle.code}${line_break}</script>${line_break}`;
         }
 
         // Include the source.

package/backend/src/{volt.js → volt.ts}

@@ -7,7 +7,7 @@
 // Exports.
 
 // Create volt lib.
-export { FrontendError, APIError } from "./utils.js"
+export { APIError } from "./utils.js"
 export * from "./status.js"
 export * from "./meta.js"
 export * from "./splash_screen.js"
@@ -22,4 +22,5 @@ export * from "./file_watcher.js"
 export * as Mail from "./plugins/mail.js"
 // export * as PDF from "./plugins/pdf.js"
 export * as TypeScript from "./plugins/ts/compiler.js"
+export * from "./plugins/css.js"
 export * from "./frontend.js"