@vandenberghinc/volt 1.1.5 → 1.1.7

package/backend/dist/esm-dev/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/esm-dev/status.js

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

package/backend/dist/esm-dev/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/esm-dev/stream.js

@@ -664,6 +664,7 @@ export 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;
@@ -688,12 +689,12 @@ export class Stream {
                 this.res_headers["Content-Type"] = "application/json";
                 body = JSON.stringify(body);
             }
-            // Respond.
-            stream.respond(this.res_headers);
             // Compress.
             if (compress) {
                 body = zlib.gzipSync(body, { level: zlib.constants.Z_BEST_COMPRESSION });
             }
+            // Respond.
+            stream.respond(this.res_headers);
             // End.
             if (body != null) {
                 stream.end(Buffer.from(body));
@@ -805,8 +806,16 @@ export 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/esm-dev/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/esm-dev/users.js

@@ -4,11 +4,11 @@
  */
 // ---------------------------------------------------------
 // Imports.
-import { vlib } from "/Users/administrator/persistance/private/dev/vinc/volt/backend/./src/vinc.dev.js";
+import { vlib } 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";
 const log_source = logger.LogSource("Users");
 // interface Server {
@@ -270,14 +270,14 @@ export 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(
@@ -331,26 +331,33 @@ export class Users {
                     username_err = err;
                 }
                 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.message } });
+                    return stream.error({
+                        status: 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.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",
+                            },
                         });
                     }
                 }
@@ -358,13 +365,12 @@ export class Users {
                     if ((uid = await this.get_uid(username)) == 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",
+                            },
                         });
                     }
                 }
@@ -470,22 +476,27 @@ 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.
                 if (this.server.enable_2fa) {
@@ -536,10 +547,9 @@ export class Users {
                 catch (err) {
                     return stream.error({
                         status: Status.bad_request,
-                        data: {
-                            error: err.message,
-                            invalid_fields: err.invalid_fields || {},
-                        }
+                        type: "InvalidParams",
+                        message: err.message,
+                        invalid_fields: err.invalid_fields || {},
                     });
                 }
                 // Sign in.
@@ -567,19 +577,17 @@ 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.
                 const err = await this.verify_2fa(uid, params.code);
                 if (err) {
                     return stream.error({
                         status: Status.forbidden,
-                        data: {
-                            error: "Permission denied.",
-                            invalid_fields: {
-                                "code": err,
-                            },
-                        }
+                        message: "Permission denied.",
+                        invalid_fields: {
+                            "code": err,
+                        },
                     });
                 }
                 // Set activated.
@@ -607,28 +615,24 @@ 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.
                 const err = await this.verify_2fa(uid, params.code);
                 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"
+                        },
                     });
                 }
                 // Set password.
@@ -674,6 +678,7 @@ export class Users {
         {
             method: "POST",
             endpoint: "/volt/user",
+            content_type: "application/json",
             authenticated: true,
             rate_limit: "global",
             callback: async (stream) => {
@@ -686,6 +691,7 @@ export class Users {
         {
             method: "POST",
             endpoint: "/volt/user/change_password",
+            content_type: "application/json",
             authenticated: true,
             rate_limit: "global",
             params: {
@@ -698,12 +704,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.",
+                        }
                     });
                 }
                 // Verify new password.
@@ -711,10 +715,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,
                     });
                 }
                 // Set password.
@@ -730,6 +732,7 @@ export class Users {
         {
             method: "DELETE",
             endpoint: "/volt/user",
+            content_type: "application/json",
             authenticated: true,
             rate_limit: "global",
             callback: async (stream) => {
@@ -748,6 +751,7 @@ export class Users {
         {
             method: "POST",
             endpoint: "/volt/user/api_key",
+            content_type: "application/json",
             authenticated: true,
             rate_limit: "global",
             callback: async (stream) => {
@@ -763,6 +767,7 @@ export class Users {
         {
             method: "DELETE",
             endpoint: "/volt/user/api_key",
+            content_type: "application/json",
             authenticated: true,
             rate_limit: "global",
             callback: async (stream) => {
@@ -777,6 +782,7 @@ export class Users {
         {
             method: "GET",
             endpoint: "/volt/user/data",
+            content_type: "application/json",
             authenticated: true,
             rate_limit: "global",
             params: {
@@ -794,6 +800,7 @@ export class Users {
         {
             method: "POST",
             endpoint: "/volt/user/data",
+            content_type: "application/json",
             authenticated: true,
             rate_limit: "global",
             params: {
@@ -812,6 +819,7 @@ export class Users {
         {
             method: "DELETE",
             endpoint: "/volt/user/data",
+            content_type: "application/json",
             authenticated: true,
             rate_limit: "global",
             params: {
@@ -831,6 +839,7 @@ export class Users {
         {
             method: "GET",
             endpoint: "/volt/user/data/protected",
+            content_type: "application/json",
             authenticated: true,
             rate_limit: "global",
             params: {
@@ -884,7 +893,7 @@ export class Users {
                         last_name = stream.param("last_name");
                     }
                     catch (err) {
-                        return stream.error({ status: Status.bad_request, data: { error: err.message } });
+                        return stream.error({ status: Status.bad_request, message: err.message });
                     }
                 }
                 else {
@@ -1106,14 +1115,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" }
+                });
             }
         }
         // Generate a uid.

package/backend/dist/esm-dev/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/esm-dev/utils.js

@@ -2,81 +2,39 @@
  * Author: Daan van den Bergh
  * Copyright: © 2022 - 2024 Daan van den Bergh.
  */
-import { vlib } from "/Users/administrator/persistance/private/dev/vinc/volt/backend/./src/vinc.dev.js";
+import { vlib } from "@vinc";
+import { Status } from "./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.
  */
-export class FrontendError extends Error {
-    name;
+export 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.internal_server_error;
         this.data = data;
-        if (invalid_fields !== undefined) {
-            this;
-            invalid_fields = invalid_fields;
-        }
+        this.invalid_fields = invalid_fields ?? {};
     }
-}
-/*  @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
- */
-export 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.internal_server_error,
+            headers: { "Content-Type": "application/json" },
+            message: this.message,
+            type: this.type,
+            invalid_fields: this.invalid_fields,
+        });
+        return this;
     }
 }
 // Implementation
 export const 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.
@@ -321,4 +279,5 @@ export const Utils = {
         new vlib.Path(path.str() + '.hash').save_sync(hash);
     },
 };
+export { Utils as utils }; // lowercase export for compatibility
 export default Utils;

package/backend/dist/esm-dev/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;
 }