@vandenberghinc/volt 1.1.4 → 1.1.6

package/backend/dist/cjs/status.d.ts

@@ -57,4 +57,5 @@ export declare const Status: {
     two_factor_auth_required: number;
     get_description(status: number): string;
 };
+export { Status as status };
 export default Status;

package/backend/dist/cjs/status.js

@@ -4,7 +4,7 @@
  * Copyright: © 2022 - 2024 Daan van den Bergh.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Status = void 0;
+exports.status = exports.Status = void 0;
 // HTTP response status.
 // - Does not include all status codes.
 /* 	@docs:
@@ -196,4 +196,5 @@ exports.Status = {
         }
     }
 };
+exports.status = exports.Status;
 exports.default = exports.Status;

package/backend/dist/cjs/stream.d.ts

@@ -55,12 +55,14 @@ export declare class Stream {
         data?: any;
         compress?: boolean;
     }): this;
-    error({ status, headers, body, data, compress }?: {
+    error({ message, type, invalid_fields, status, headers, compress, data, }: {
+        message: string;
+        type?: string;
+        invalid_fields?: Record<string, string>;
         status?: number;
         headers?: Record<string, any>;
-        body?: any;
-        data?: any;
         compress?: boolean;
+        data?: any[] | Record<string, any>;
     }): this;
     set_header(name: string, value: any): this;
     set_headers(headers?: Record<string, any>): this;

package/backend/dist/cjs/stream.js

@@ -670,6 +670,7 @@ class Stream {
      *      stream.send({status: 200, data: "Hello World!"});
      */
     send({ status = 200, headers = {}, body = null, data = null, compress = false } = {}) {
+        compress = false; // @todo @tmp
         // Copy body.
         if (data != null) {
             body = data;
@@ -694,12 +695,12 @@ class Stream {
                 this.res_headers["Content-Type"] = "application/json";
                 body = JSON.stringify(body);
             }
-            // Respond.
-            stream.respond(this.res_headers);
             // Compress.
             if (compress) {
                 body = zlib_1.default.gzipSync(body, { level: zlib_1.default.constants.Z_BEST_COMPRESSION });
             }
+            // Respond.
+            stream.respond(this.res_headers);
             // End.
             if (body != null) {
                 stream.end(Buffer.from(body));
@@ -811,8 +812,16 @@ class Stream {
      *      ...
      *      stream.error({data: "Some error occured"});
      */
-    error({ status = 500, headers = {}, body = null, data = null, compress = false } = {}) {
-        return this.send({ status: status, headers: headers, body: body ?? data, compress: compress });
+    error({ message, type = "APIError", invalid_fields = {}, status = 500, headers = {}, compress = false, data = undefined, }) {
+        return this.send({ status: status, headers: headers, compress: compress, body: {
+                error: {
+                    type,
+                    message,
+                    status,
+                    invalid_fields,
+                },
+                data,
+            } });
     }
     // Set headers.
     /*  @docs:

package/backend/dist/cjs/users.d.ts

@@ -55,7 +55,7 @@ export declare class Users {
     _create_user_cookie(stream: Stream, uid: string): Promise<void>;
     _create_detailed_user_cookie(stream: Stream, uid: string): Promise<void>;
     _reset_cookies(stream: Stream): void;
-    _initialize(): void;
+    _initialize(): Promise<void>;
     uid_exists(uid: string): Promise<boolean>;
     username_exists(username: string): Promise<boolean>;
     email_exists(email: string): Promise<boolean>;

package/backend/dist/cjs/users.js

@@ -44,7 +44,7 @@ const _vinc_1 = require("./vinc.js");
 const utils = __importStar(require("./utils.js"));
 const Mail = __importStar(require("./plugins/mail.js"));
 const status_js_1 = require("./status.js");
-const { FrontendError } = utils;
+const { APIError } = utils;
 const logger_js_1 = require("./logger.js");
 const log_source = logger_js_1.logger.LogSource("Users");
 // interface Server {
@@ -306,14 +306,14 @@ class Users {
     // ---------------------------------------------------------
     // Initialization (private).
     // Initialize.
-    _initialize() {
+    async _initialize() {
         // 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.
         this.server.endpoint(
@@ -367,26 +367,33 @@ class Users {
                     username_err = err;
                 }
                 if (email_err && username_err) {
-                    return stream.error({ status: status_js_1.Status.bad_request, data: { error: email_err.message } });
+                    return stream.error({
+                        status: status_js_1.Status.bad_request,
+                        type: "InvalidParams",
+                        message: email_err.message,
+                    });
                 }
                 try {
                     password = stream.param("password");
                 }
                 catch (err) {
-                    return stream.error({ status: status_js_1.Status.bad_request, data: { error: err.message } });
+                    return stream.error({
+                        status: status_js_1.Status.bad_request,
+                        type: "InvalidParams",
+                        message: err.message,
+                    });
                 }
                 // Get uid.
                 if (email) {
                     if ((uid = await this.get_uid_by_email(email)) == null) {
                         return stream.error({
                             status: status_js_1.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",
+                            },
                         });
                     }
                 }
@@ -394,13 +401,12 @@ class Users {
                     if ((uid = await this.get_uid(username)) == null) {
                         return stream.error({
                             status: status_js_1.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",
+                            },
                         });
                     }
                 }
@@ -506,22 +512,27 @@ class Users {
                 if (error) {
                     return stream.error({
                         status: status_js_1.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_js_1.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_js_1.Status.bad_request,
+                        invalid_fields: { "email": "Email is already registered" }
+                    });
                 }
                 // Verify 2fa.
                 if (this.server.enable_2fa) {
@@ -572,10 +583,9 @@ class Users {
                 catch (err) {
                     return stream.error({
                         status: status_js_1.Status.bad_request,
-                        data: {
-                            error: err.message,
-                            invalid_fields: err.invalid_fields || {},
-                        }
+                        type: "InvalidParams",
+                        message: err.message,
+                        invalid_fields: err.invalid_fields || {},
                     });
                 }
                 // Sign in.
@@ -603,19 +613,17 @@ class Users {
                 }
                 // Check uid.
                 if (uid == null) {
-                    return stream.error({ status: status_js_1.Status.forbidden, data: { error: "Permission denied." } });
+                    return stream.error({ status: status_js_1.Status.forbidden, message: "Permission denied." });
                 }
                 // Verify.
                 const err = await this.verify_2fa(uid, params.code);
                 if (err) {
                     return stream.error({
                         status: status_js_1.Status.forbidden,
-                        data: {
-                            error: "Permission denied.",
-                            invalid_fields: {
-                                "code": err,
-                            },
-                        }
+                        message: "Permission denied.",
+                        invalid_fields: {
+                            "code": err,
+                        },
                     });
                 }
                 // Set activated.
@@ -643,28 +651,24 @@ class Users {
                 if (error) {
                     return stream.error({
                         status: status_js_1.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_js_1.Status.forbidden, data: { error: "Invalid email." } });
+                    return stream.error({ status: status_js_1.Status.forbidden, message: "Invalid email." });
                 }
                 // Verify 2fa.
                 const err = await this.verify_2fa(uid, params.code);
                 if (err) {
                     return stream.error({
                         status: status_js_1.Status.forbidden,
-                        data: {
-                            error: "Invalid 2FA code.",
-                            invalid_fields: {
-                                "code": "Invalid code"
-                            },
-                        }
+                        message: "Invalid 2FA code.",
+                        invalid_fields: {
+                            "code": "Invalid code"
+                        },
                     });
                 }
                 // Set password.
@@ -710,6 +714,7 @@ class Users {
         {
             method: "POST",
             endpoint: "/volt/user",
+            content_type: "application/json",
             authenticated: true,
             rate_limit: "global",
             callback: async (stream) => {
@@ -722,6 +727,7 @@ class Users {
         {
             method: "POST",
             endpoint: "/volt/user/change_password",
+            content_type: "application/json",
             authenticated: true,
             rate_limit: "global",
             params: {
@@ -734,12 +740,10 @@ class Users {
                 if (await this.verify_password(stream.uid, params.current_password) !== true) {
                     return stream.error({
                         status: status_js_1.Status.unauthorized,
-                        data: {
-                            error: "Incorrect password.",
-                            invalid_fields: {
-                                current_password: "Incorrect password.",
-                            }
-                        },
+                        message: "Incorrect password.",
+                        invalid_fields: {
+                            current_password: "Incorrect password.",
+                        }
                     });
                 }
                 // Verify new password.
@@ -747,10 +751,8 @@ class Users {
                 if (error) {
                     return stream.error({
                         status: status_js_1.Status.bad_request,
-                        data: {
-                            error: error,
-                            invalid_fields,
-                        }
+                        message: error,
+                        invalid_fields: invalid_fields ?? undefined,
                     });
                 }
                 // Set password.
@@ -766,6 +768,7 @@ class Users {
         {
             method: "DELETE",
             endpoint: "/volt/user",
+            content_type: "application/json",
             authenticated: true,
             rate_limit: "global",
             callback: async (stream) => {
@@ -784,6 +787,7 @@ class Users {
         {
             method: "POST",
             endpoint: "/volt/user/api_key",
+            content_type: "application/json",
             authenticated: true,
             rate_limit: "global",
             callback: async (stream) => {
@@ -799,6 +803,7 @@ class Users {
         {
             method: "DELETE",
             endpoint: "/volt/user/api_key",
+            content_type: "application/json",
             authenticated: true,
             rate_limit: "global",
             callback: async (stream) => {
@@ -813,6 +818,7 @@ class Users {
         {
             method: "GET",
             endpoint: "/volt/user/data",
+            content_type: "application/json",
             authenticated: true,
             rate_limit: "global",
             params: {
@@ -830,6 +836,7 @@ class Users {
         {
             method: "POST",
             endpoint: "/volt/user/data",
+            content_type: "application/json",
             authenticated: true,
             rate_limit: "global",
             params: {
@@ -848,6 +855,7 @@ class Users {
         {
             method: "DELETE",
             endpoint: "/volt/user/data",
+            content_type: "application/json",
             authenticated: true,
             rate_limit: "global",
             params: {
@@ -867,6 +875,7 @@ class Users {
         {
             method: "GET",
             endpoint: "/volt/user/data/protected",
+            content_type: "application/json",
             authenticated: true,
             rate_limit: "global",
             params: {
@@ -920,7 +929,7 @@ class Users {
                         last_name = stream.param("last_name");
                     }
                     catch (err) {
-                        return stream.error({ status: status_js_1.Status.bad_request, data: { error: err.message } });
+                        return stream.error({ status: status_js_1.Status.bad_request, message: err.message });
                     }
                 }
                 else {
@@ -1142,14 +1151,20 @@ 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_js_1.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_js_1.Status.bad_request,
+                    invalid_fields: { "email": "Email is already registered" }
+                });
             }
         }
         // Generate a uid.

package/backend/dist/cjs/utils.d.ts

@@ -1,15 +1,22 @@
-export declare class FrontendError extends Error {
-    name: string;
-    status?: number;
-    data?: any;
+import type { Stream } from "./stream.js";
+/**
+ * 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 declare class APIError extends Error {
+    type: string;
+    status: number;
+    data?: any[] | Record<string, any>;
     invalid_fields: Record<string, string>;
-    constructor(message: string, status?: number, data?: any, invalid_fields?: Record<string, string>);
-}
-export declare class APIError extends FrontendError {
-    constructor(message: string, status?: number, data?: any, invalid_fields?: Record<string, string>);
+    constructor({ type, message, status, data, invalid_fields }: {
+        type?: string;
+        message: string;
+        status?: number;
+        data?: any;
+        invalid_fields?: Record<string, string>;
+    });
+    serve(stream: Stream): this;
 }
 interface UtilsInt {
-    "FrontendError": typeof FrontendError;
     "APIError": typeof APIError;
     clean_endpoint(endpoint: undefined): undefined;
     clean_endpoint(endpoint: RegExp): RegExp;
@@ -24,4 +31,5 @@ interface UtilsInt {
     set_compiled_cache(path: any, data: string, hash: string): void;
 }
 export declare const Utils: UtilsInt;
+export { Utils as utils };
 export default Utils;

package/backend/dist/cjs/utils.js

@@ -4,84 +4,41 @@
  * Copyright: © 2022 - 2024 Daan van den Bergh.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Utils = exports.APIError = exports.FrontendError = void 0;
+exports.utils = exports.Utils = exports.APIError = void 0;
 const _vinc_1 = require("./vinc.js");
+const status_js_1 = require("./status.js");
 // ---------------------------------------------------------
 // Utils.
-/*  @docs:
- *  @nav: Backend
-    @parent: Utils
-    @chapter: Exceptions
-    @title: Frontend Error
-    @description:
-        The frontend error class can be 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.
-    @usage:
-        throw new volt.FrontendError("Some error occured.");
-        throw new volt.FrontendError("Bad request.", volt.status.bad_request);
-    @param:
-        @name: message
-        @descr: The error message.
-        @type: string
-    @param:
-        @name: status
-        @descr: The http error status.
-        @type: number
-    @param:
-        @name: data
-        @descr: The error body data.
-        @type: any
+/**
+ * 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.
  */
-class FrontendError extends Error {
-    name;
+class APIError extends Error {
+    type;
     status;
     data;
-    invalid_fields = {};
-    constructor(message, status, data, invalid_fields) {
+    invalid_fields;
+    constructor({ type = "APIError", message, status, data, invalid_fields }) {
         super(message);
-        this.name = "FrontendError";
-        this.status = status;
+        this.name = "APIError";
+        this.type = type;
+        this.status = status ?? status_js_1.Status.internal_server_error;
         this.data = data;
-        if (invalid_fields !== undefined) {
-            this;
-            invalid_fields = invalid_fields;
-        }
+        this.invalid_fields = invalid_fields ?? {};
     }
-}
-exports.FrontendError = FrontendError;
-/*  @docs:
- *  @nav: Backend
-    @parent: Utils
-    @chapter: Exceptions
-    @title: API Error
-    @description:
-        The api error class can be 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.
-    @usage:
-        throw new volt.APIError("Some error occured.");
-        throw new volt.APIError("Bad request.", volt.status.bad_request);
-    @param:
-        @name: message
-        @descr: The error message.
-        @type: string
-    @param:
-        @name: status
-        @descr: The http error status.
-        @type: number
-    @param:
-        @name: data
-        @descr: The error body data.
-        @type: any
- */
-class APIError extends FrontendError {
-    constructor(message, status, data, invalid_fields) {
-        super(message, status, data, invalid_fields);
-        this.name = "APIError";
+    serve(stream) {
+        stream.error({
+            status: this.status ?? status_js_1.Status.internal_server_error,
+            headers: { "Content-Type": "application/json" },
+            message: this.message,
+            type: this.type,
+            invalid_fields: this.invalid_fields,
+        });
+        return this;
     }
 }
 exports.APIError = APIError;
 // Implementation
 exports.Utils = {
-    // An error that may be shown to the frontend user.
-    "FrontendError": FrontendError,
     // An error that may be shown to the frontend user.
     "APIError": APIError,
     // Clean an endpoint url.
@@ -326,4 +283,5 @@ exports.Utils = {
         new _vinc_1.vlib.Path(path.str() + '.hash').save_sync(hash);
     },
 };
+exports.utils = exports.Utils;
 exports.default = exports.Utils;

package/backend/dist/cjs/view.d.ts

@@ -23,7 +23,7 @@ export declare class View {
     is_js_ts_view: boolean;
     html?: string | Buffer;
     raw_html?: string | Buffer;
-    bundle: any;
+    _bundle: any;
     payments?: string | undefined;
     min_device_width?: number;
     _server?: any;
@@ -45,7 +45,7 @@ export declare class View {
         _src?: string;
     });
     _initialize(server: any, endpoint: any): void;
-    _bundle_ts(dist_path: string, bundle?: any): Promise<any>;
+    _dynamic_bundle(): Promise<void>;
     _build_html(): Promise<void>;
     _serve(stream: any, status_code?: number): void;
 }