@vandenberghinc/volt 1.1.12 → 1.1.14

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

@@ -13,7 +13,7 @@ type IndexOptions = (BaseOptions & {
     key?: never;
     keys: string[];
 });
-declare class Collection {
+export declare class Collection {
     static chunk_size: number;
     static constructor_scheme: {
         name: string;
@@ -103,7 +103,7 @@ declare class Collection {
     /** Write bulk operations. */
     bulk_operations(operations?: any[]): Promise<any>;
 }
-declare class UIDCollection {
+export declare class UIDCollection {
     private _col;
     col: MongoCollection;
     constructor(name: string, collection: MongoCollection, indexes?: IndexOptions[], ttl?: number | null);
@@ -144,7 +144,7 @@ declare class UIDCollection {
     /** Write bulk operations. */
     bulk_operations(operations?: any[]): Promise<any>;
 }
-declare class Database {
+export declare class Database {
     static constructor_scheme: {
         uri: {
             type: string;
@@ -334,4 +334,30 @@ declare class Database {
     } | string): Promise<UIDCollection>;
     get_collections(): Promise<string[]>;
 }
-export { Collection, UIDCollection, Database };
+/** Objective document class. */
+export declare class UIDDocument<DocumentOptions = any> {
+    col: UIDCollection;
+    data?: DocumentOptions;
+    uid: string;
+    path: string | Record<string, any>;
+    chunked: boolean;
+    error_document_name: string;
+    constructor({ col, uid, path, data, chunked, error_document_name }: {
+        col: UIDCollection;
+        uid: string;
+        path: string | Record<string, any>;
+        data?: DocumentOptions;
+        chunked?: boolean;
+        error_document_name?: string;
+    });
+    /** As database document. */
+    document(): undefined | DocumentOptions;
+    /** Check if a project exists. */
+    exists(): Promise<boolean>;
+    /** Load a project from the database */
+    load(): Promise<DocumentOptions>;
+    try_load(): Promise<undefined | DocumentOptions>;
+    /** Save the project to the database */
+    save(): Promise<void>;
+}
+export {};

package/backend/dist/cjs/database.js

@@ -4,14 +4,16 @@
  * Copyright: © 2022 - 2024 Daan van den Bergh.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Database = exports.UIDCollection = exports.Collection = void 0;
+exports.UIDDocument = exports.Database = exports.UIDCollection = exports.Collection = void 0;
 // ---------------------------------------------------------
 // Libraries.
 const child_process_1 = require("child_process");
 const bson_1 = require("bson");
 const mongodb_1 = require("mongodb");
 const logger_js_1 = require("./logger.js");
+const status_js_1 = require("./status.js");
 const _vinc_1 = require("./vinc.js");
+const utils_js_1 = require("./utils.js");
 const log_source = new logger_js_1.LogSource("Database");
 // ---------------------------------------------------------
 // Collection.
@@ -2018,3 +2020,76 @@ class Database {
     }
 }
 exports.Database = Database;
+// ---------------------------------------------------------
+/** Objective document class. */
+class UIDDocument {
+    col;
+    data;
+    uid;
+    path;
+    chunked;
+    error_document_name;
+    constructor({ col, uid, path, data, chunked = false, error_document_name = "document" }) {
+        this.col = col;
+        this.uid = uid;
+        this.path = path;
+        this.data = data;
+        this.chunked = chunked;
+        this.error_document_name = error_document_name;
+    }
+    /** As database document. */
+    document() {
+        return this.data;
+    }
+    /** Check if a project exists. */
+    async exists() {
+        return await this.col.exists(this.uid, this.path);
+    }
+    /** Load a project from the database */
+    async load() {
+        const data = await this.col.load(this.uid, this.path, { chunked: this.chunked });
+        if (!data) {
+            let id = this.uid + "/";
+            if (typeof this.path === "string") {
+                id += this.path;
+            }
+            else {
+                id += Object.values(this.path).join("@");
+            }
+            throw new utils_js_1.InternalError({
+                type: "DocumentNotFound",
+                message: `Requested ${this.error_document_name} "${id}" does not exist.`,
+                status: status_js_1.Status.bad_request,
+            });
+        }
+        this.data = data;
+        return this.data;
+    }
+    async try_load() {
+        const data = await this.col.load(this.uid, this.path, { chunked: this.chunked });
+        if (!data) {
+            return undefined;
+        }
+        this.data = data;
+        return this.data;
+    }
+    /** Save the project to the database */
+    async save() {
+        if (!this.data) {
+            let id = this.uid + "/";
+            if (typeof this.path === "string") {
+                id += this.path;
+            }
+            else {
+                id += Object.values(this.path).join("@");
+            }
+            throw new utils_js_1.InternalError({
+                type: "DocumentNotFound",
+                message: `Document "${id}" is not loaded yet.`,
+                status: status_js_1.Status.bad_request,
+            });
+        }
+        await this.col.save(this.uid, this.path, this.data, { chunked: this.chunked });
+    }
+}
+exports.UIDDocument = UIDDocument;

package/backend/dist/cjs/endpoint.js

@@ -461,7 +461,7 @@ class Endpoint {
                     }
                 }
                 catch (err) {
-                    if (err instanceof utils_js_1.APIError) {
+                    if (err instanceof utils_js_1.ExternalError || err instanceof utils_js_1.InternalError) {
                         err.serve(stream);
                     }
                     else {

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

@@ -624,7 +624,7 @@ class Paddle {
         }
         // Cancel.
         if (subscription.status !== "active") {
-            throw new utils_js_1.APIError({
+            throw new utils_js_1.ExternalError({
                 type: "NoActiveSubscriptionError",
                 message: `This subscription is already cancelled and will become inactive at the end of the billing period.`,
                 status: status_js_1.Status.bad_request,
@@ -1990,7 +1990,7 @@ class Paddle {
             }
         });
         if (_throw_no_cancelled_err && cancelled.length === 0) {
-            throw new utils_js_1.APIError({
+            throw new utils_js_1.ExternalError({
                 type: "NoCancellableSubscriptions",
                 message: "No cancellable subscriptions found.",
                 status: status_js_1.Status.bad_request,

package/backend/dist/cjs/server.js

@@ -974,14 +974,6 @@ class Server {
         // this.ts = ts as TypeScriptConfig;
         this.endpoints = new Map();
         this.err_endpoints = new Map();
-        // Assign based on localhost.
-        // if (localhost) {
-        //     this.ip = "127.0.0.1";
-        //     this.domain = this.ip + ":" + (port + (this.tls ? 1 : 0));
-        // } else if (!production && !localhost && ip == null)  { // use argument ip not attr since that already has a default.
-        //     this.ip = vlib.Network.private_ip();
-        //     this.domain = this.ip + ":" + (port + (this.tls ? 1 : 0));
-        // }
         /* @performance */ this.performance = new _vinc_1.vlib.Performance("Server performance");
         // Assign objects to server so it is easy to access.
         this.status = status_js_1.Status;

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 { APIError } = utils;
+const { ExternalError } = utils;
 const logger_js_1 = require("./logger.js");
 const log_source = logger_js_1.logger.LogSource("Users");
 // interface Server {
@@ -519,7 +519,7 @@ class Users {
                 }
                 // Verify username and email.
                 if (await this.username_exists(params.username)) {
-                    throw new APIError({
+                    throw new ExternalError({
                         type: "UsernameAlreadyExists",
                         message: `Username "${params.username}" is already registered.`,
                         status: status_js_1.Status.bad_request,
@@ -527,7 +527,7 @@ class Users {
                     });
                 }
                 if (await this.email_exists(params.email)) {
-                    throw new APIError({
+                    throw new ExternalError({
                         type: "EmailAlreadyExists",
                         message: `Email "${params.email}" is already registered.`,
                         status: status_js_1.Status.bad_request,
@@ -1151,7 +1151,7 @@ class Users {
         // Check if username & email already exist.
         if (_check_username_email) {
             if (await this.username_exists(username)) {
-                throw new APIError({
+                throw new ExternalError({
                     type: "UsernameAlreadyExists",
                     message: `Username "${username}" is already registered.`,
                     status: status_js_1.Status.bad_request,
@@ -1159,7 +1159,7 @@ class Users {
                 });
             }
             if (await this.email_exists(email)) {
-                throw new APIError({
+                throw new ExternalError({
                     type: "EmailAlreadyExists",
                     message: `Email "${email}" is already registered.`,
                     status: status_js_1.Status.bad_request,

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

@@ -1,8 +1,8 @@
 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.
+ * The base class for internal and external errors.
  */
-export declare class APIError extends Error {
+declare class BaseError extends Error {
     type: string;
     status: number;
     data?: any[] | Record<string, any>;
@@ -16,8 +16,22 @@ export declare class APIError extends Error {
     });
     serve(stream: Stream): this;
 }
+/**
+ * Thrown external errors are presented to the user.
+ */
+export declare class ExternalError extends BaseError {
+    constructor(args: ConstructorParameters<typeof BaseError>[0]);
+    serve(stream: Stream): this;
+}
+/**
+ * Thrown internal errors are not presented to the user, isntead an internal server error message is shown.
+ */
+export declare class InternalError extends BaseError {
+    constructor(args: ConstructorParameters<typeof BaseError>[0]);
+    serve(stream: Stream): this;
+}
 interface UtilsInt {
-    "APIError": typeof APIError;
+    "APIError": typeof ExternalError;
     clean_endpoint(endpoint: undefined): undefined;
     clean_endpoint(endpoint: RegExp): RegExp;
     clean_endpoint(endpoint: string): string;

package/backend/dist/cjs/utils.js

@@ -4,15 +4,15 @@
  * Copyright: © 2022 - 2024 Daan van den Bergh.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.utils = exports.Utils = exports.APIError = void 0;
+exports.utils = exports.Utils = exports.InternalError = exports.ExternalError = void 0;
 const _vinc_1 = require("./vinc.js");
 const status_js_1 = require("./status.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.
+ * The base class for internal and external errors.
  */
-class APIError extends Error {
+class BaseError extends Error {
     type;
     status;
     data;
@@ -36,11 +36,49 @@ class APIError extends Error {
         return this;
     }
 }
-exports.APIError = APIError;
+/**
+ * Thrown external errors are presented to the user.
+ */
+class ExternalError extends BaseError {
+    constructor(args) {
+        args.type ??= "ExternalError";
+        super(args);
+    }
+    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.ExternalError = ExternalError;
+/**
+ * Thrown internal errors are not presented to the user, isntead an internal server error message is shown.
+ */
+class InternalError extends BaseError {
+    constructor(args) {
+        args.type ??= "InternalError";
+        super(args);
+    }
+    serve(stream) {
+        stream.error({
+            status: status_js_1.Status.internal_server_error,
+            headers: { "Content-Type": "application/json" },
+            message: "Internal Server Error",
+            type: "InternalServerError",
+        });
+        return this;
+    }
+}
+exports.InternalError = InternalError;
 // Implementation
 exports.Utils = {
     // An error that may be shown to the frontend user.
-    "APIError": APIError,
+    "APIError": ExternalError,
     // Clean an endpoint url.
     clean_endpoint(endpoint) {
         if (endpoint == null || endpoint instanceof RegExp) {

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

@@ -1,4 +1,4 @@
-export { APIError } from "./utils.js";
+export { ExternalError as APIError } from "./utils.js";
 export * from "./status.js";
 export * from "./meta.js";
 export * from "./splash_screen.js";

package/backend/dist/cjs/volt.js

@@ -45,7 +45,7 @@ exports.TypeScript = exports.Mail = exports.APIError = void 0;
 // Exports.
 // Create volt lib.
 var utils_js_1 = require("./utils.js");
-Object.defineProperty(exports, "APIError", { enumerable: true, get: function () { return utils_js_1.APIError; } });
+Object.defineProperty(exports, "APIError", { enumerable: true, get: function () { return utils_js_1.ExternalError; } });
 __exportStar(require("./status.js"), exports);
 __exportStar(require("./meta.js"), exports);
 __exportStar(require("./splash_screen.js"), exports);

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

@@ -13,7 +13,7 @@ type IndexOptions = (BaseOptions & {
     key?: never;
     keys: string[];
 });
-declare class Collection {
+export declare class Collection {
     static chunk_size: number;
     static constructor_scheme: {
         name: string;
@@ -103,7 +103,7 @@ declare class Collection {
     /** Write bulk operations. */
     bulk_operations(operations?: any[]): Promise<any>;
 }
-declare class UIDCollection {
+export declare class UIDCollection {
     private _col;
     col: MongoCollection;
     constructor(name: string, collection: MongoCollection, indexes?: IndexOptions[], ttl?: number | null);
@@ -144,7 +144,7 @@ declare class UIDCollection {
     /** Write bulk operations. */
     bulk_operations(operations?: any[]): Promise<any>;
 }
-declare class Database {
+export declare class Database {
     static constructor_scheme: {
         uri: {
             type: string;
@@ -334,4 +334,30 @@ declare class Database {
     } | string): Promise<UIDCollection>;
     get_collections(): Promise<string[]>;
 }
-export { Collection, UIDCollection, Database };
+/** Objective document class. */
+export declare class UIDDocument<DocumentOptions = any> {
+    col: UIDCollection;
+    data?: DocumentOptions;
+    uid: string;
+    path: string | Record<string, any>;
+    chunked: boolean;
+    error_document_name: string;
+    constructor({ col, uid, path, data, chunked, error_document_name }: {
+        col: UIDCollection;
+        uid: string;
+        path: string | Record<string, any>;
+        data?: DocumentOptions;
+        chunked?: boolean;
+        error_document_name?: string;
+    });
+    /** As database document. */
+    document(): undefined | DocumentOptions;
+    /** Check if a project exists. */
+    exists(): Promise<boolean>;
+    /** Load a project from the database */
+    load(): Promise<DocumentOptions>;
+    try_load(): Promise<undefined | DocumentOptions>;
+    /** Save the project to the database */
+    save(): Promise<void>;
+}
+export {};

package/backend/dist/esm/database.js

@@ -8,7 +8,9 @@ import { spawn } from "child_process";
 import { deserialize, serialize } from "bson";
 import { MongoClient, ServerApiVersion } from 'mongodb';
 import { logger, LogSource } from "./logger.js";
+import { Status } from "./status.js";
 import { vlib } from "./vinc.js";
+import { InternalError } from "./utils.js";
 const log_source = new LogSource("Database");
 // ---------------------------------------------------------
 // Collection.
@@ -25,7 +27,7 @@ const log_source = new LogSource("Database");
         @name: col
         @desc: The native mongodb collection.
 */
-class Collection {
+export class Collection {
     // Static attributes.
     static chunk_size = 1024 * 1024 * 4; // 4MB chunks, lower is better for frequent updates.
     static constructor_scheme = {
@@ -744,7 +746,7 @@ class Collection {
         @name: col
         @desc: The native mongodb collection.
 */
-class UIDCollection {
+export class UIDCollection {
     _col;
     col;
     constructor(name, collection, indexes = [], ttl = null) {
@@ -1127,7 +1129,7 @@ class UIDCollection {
         @desc: The MongoClient options.
         @type: null, object
 */
-class Database {
+export class Database {
     static constructor_scheme = {
         uri: { type: "string", default: null },
         source: { type: "string", default: null },
@@ -2012,4 +2014,75 @@ class Database {
         });
     }
 }
-export { Collection, UIDCollection, Database };
+// ---------------------------------------------------------
+/** Objective document class. */
+export class UIDDocument {
+    col;
+    data;
+    uid;
+    path;
+    chunked;
+    error_document_name;
+    constructor({ col, uid, path, data, chunked = false, error_document_name = "document" }) {
+        this.col = col;
+        this.uid = uid;
+        this.path = path;
+        this.data = data;
+        this.chunked = chunked;
+        this.error_document_name = error_document_name;
+    }
+    /** As database document. */
+    document() {
+        return this.data;
+    }
+    /** Check if a project exists. */
+    async exists() {
+        return await this.col.exists(this.uid, this.path);
+    }
+    /** Load a project from the database */
+    async load() {
+        const data = await this.col.load(this.uid, this.path, { chunked: this.chunked });
+        if (!data) {
+            let id = this.uid + "/";
+            if (typeof this.path === "string") {
+                id += this.path;
+            }
+            else {
+                id += Object.values(this.path).join("@");
+            }
+            throw new InternalError({
+                type: "DocumentNotFound",
+                message: `Requested ${this.error_document_name} "${id}" does not exist.`,
+                status: Status.bad_request,
+            });
+        }
+        this.data = data;
+        return this.data;
+    }
+    async try_load() {
+        const data = await this.col.load(this.uid, this.path, { chunked: this.chunked });
+        if (!data) {
+            return undefined;
+        }
+        this.data = data;
+        return this.data;
+    }
+    /** Save the project to the database */
+    async save() {
+        if (!this.data) {
+            let id = this.uid + "/";
+            if (typeof this.path === "string") {
+                id += this.path;
+            }
+            else {
+                id += Object.values(this.path).join("@");
+            }
+            throw new InternalError({
+                type: "DocumentNotFound",
+                message: `Document "${id}" is not loaded yet.`,
+                status: Status.bad_request,
+            });
+        }
+        await this.col.save(this.uid, this.path, this.data, { chunked: this.chunked });
+    }
+}

package/backend/dist/esm/endpoint.js

@@ -8,7 +8,7 @@ import CleanCSS from 'clean-css';
 import zlib from 'zlib';
 import { View } from './view.js';
 import { vlib } from "./vinc.js";
-import { Utils, APIError } from "./utils.js";
+import { Utils, ExternalError, InternalError } from "./utils.js";
 import { Status } from "./status.js";
 import { logger, LogSource } from "./logger.js";
 import { RateLimits } from "./rate_limit.js";
@@ -455,7 +455,7 @@ class Endpoint {
                     }
                 }
                 catch (err) {
-                    if (err instanceof APIError) {
+                    if (err instanceof ExternalError || err instanceof InternalError) {
                         err.serve(stream);
                     }
                     else {

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

@@ -8,7 +8,7 @@ import * as PDFDocument from "pdfkit";
 import * as libcrypto from "crypto";
 import blobstream from 'blob-stream';
 import { vlib } from "../vinc.js";
-import { Utils, APIError } from "../utils.js";
+import { Utils, ExternalError } from "../utils.js";
 import { logger } from "../logger.js";
 import { Status } from "../status.js";
 const log_source = logger.LogSource("Payments");
@@ -585,7 +585,7 @@ export class Paddle {
         }
         // Cancel.
         if (subscription.status !== "active") {
-            throw new APIError({
+            throw new ExternalError({
                 type: "NoActiveSubscriptionError",
                 message: `This subscription is already cancelled and will become inactive at the end of the billing period.`,
                 status: Status.bad_request,
@@ -1951,7 +1951,7 @@ export class Paddle {
             }
         });
         if (_throw_no_cancelled_err && cancelled.length === 0) {
-            throw new APIError({
+            throw new ExternalError({
                 type: "NoCancellableSubscriptions",
                 message: "No cancellable subscriptions found.",
                 status: Status.bad_request,

package/backend/dist/esm/server.js

@@ -935,14 +935,6 @@ export class Server {
         // this.ts = ts as TypeScriptConfig;
         this.endpoints = new Map();
         this.err_endpoints = new Map();
-        // Assign based on localhost.
-        // if (localhost) {
-        //     this.ip = "127.0.0.1";
-        //     this.domain = this.ip + ":" + (port + (this.tls ? 1 : 0));
-        // } else if (!production && !localhost && ip == null)  { // use argument ip not attr since that already has a default.
-        //     this.ip = vlib.Network.private_ip();
-        //     this.domain = this.ip + ":" + (port + (this.tls ? 1 : 0));
-        // }
         /* @performance */ this.performance = new vlib.Performance("Server performance");
         // Assign objects to server so it is easy to access.
         this.status = Status;

package/backend/dist/esm/users.js

@@ -8,7 +8,7 @@ import { vlib } from "./vinc.js";
 import * as utils from "./utils.js";
 import * as Mail from "./plugins/mail.js";
 import { Status } from "./status.js";
-const { APIError } = utils;
+const { ExternalError } = utils;
 import { logger } from "./logger.js";
 const log_source = logger.LogSource("Users");
 // interface Server {
@@ -483,7 +483,7 @@ export class Users {
                 }
                 // Verify username and email.
                 if (await this.username_exists(params.username)) {
-                    throw new APIError({
+                    throw new ExternalError({
                         type: "UsernameAlreadyExists",
                         message: `Username "${params.username}" is already registered.`,
                         status: Status.bad_request,
@@ -491,7 +491,7 @@ export class Users {
                     });
                 }
                 if (await this.email_exists(params.email)) {
-                    throw new APIError({
+                    throw new ExternalError({
                         type: "EmailAlreadyExists",
                         message: `Email "${params.email}" is already registered.`,
                         status: Status.bad_request,
@@ -1115,7 +1115,7 @@ export class Users {
         // Check if username & email already exist.
         if (_check_username_email) {
             if (await this.username_exists(username)) {
-                throw new APIError({
+                throw new ExternalError({
                     type: "UsernameAlreadyExists",
                     message: `Username "${username}" is already registered.`,
                     status: Status.bad_request,
@@ -1123,7 +1123,7 @@ export class Users {
                 });
             }
             if (await this.email_exists(email)) {
-                throw new APIError({
+                throw new ExternalError({
                     type: "EmailAlreadyExists",
                     message: `Email "${email}" is already registered.`,
                     status: Status.bad_request,