@vandenberghinc/volt 1.2.5 → 1.2.6

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

@@ -1,24 +0,0 @@
-/**
- * @author Daan van den Bergh
- * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
- */
-export * from "./errors/index.js";
-export * from "./status.js";
-export * from "./meta.js";
-export * from "./splash_screen.js";
-export * from "./view.js";
-export * from "./stream.js";
-export * from "./endpoint.js";
-export * from "./server.js";
-export * from "./database/database.js";
-export * from "./database/document.js";
-export * from "./database/collection.js";
-export * from "./database/quota/quota.js";
-export * from "./database/quota/safe_int.js";
-export * from "./rate_limit.js";
-export * from "./logger.js";
-export * from "./events.js";
-export { User } from "./users.js";
-export * as Mail from "./plugins/mail/ui.js";
-export * from "./frontend.js";
-export type { Request } from "../../frontend/src/modules/request.js";

package/backend/dist/cjs/backend/src/volt.js

@@ -1,72 +0,0 @@
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var stdin_exports = {};
-__export(stdin_exports, {
-  Mail: () => Mail
-});
-module.exports = __toCommonJS(stdin_exports);
-__reExport(stdin_exports, require("./errors/index.js"), module.exports);
-__reExport(stdin_exports, require("./status.js"), module.exports);
-__reExport(stdin_exports, require("./meta.js"), module.exports);
-__reExport(stdin_exports, require("./splash_screen.js"), module.exports);
-__reExport(stdin_exports, require("./view.js"), module.exports);
-__reExport(stdin_exports, require("./stream.js"), module.exports);
-__reExport(stdin_exports, require("./endpoint.js"), module.exports);
-__reExport(stdin_exports, require("./server.js"), module.exports);
-__reExport(stdin_exports, require("./database/database.js"), module.exports);
-__reExport(stdin_exports, require("./database/document.js"), module.exports);
-__reExport(stdin_exports, require("./database/collection.js"), module.exports);
-__reExport(stdin_exports, require("./database/quota/quota.js"), module.exports);
-__reExport(stdin_exports, require("./database/quota/safe_int.js"), module.exports);
-__reExport(stdin_exports, require("./rate_limit.js"), module.exports);
-__reExport(stdin_exports, require("./logger.js"), module.exports);
-__reExport(stdin_exports, require("./events.js"), module.exports);
-var Mail = __toESM(require("./plugins/mail/ui.js"));
-__reExport(stdin_exports, require("./frontend.js"), module.exports);
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  Mail,
-  ...require("./errors/index.js"),
-  ...require("./status.js"),
-  ...require("./meta.js"),
-  ...require("./splash_screen.js"),
-  ...require("./view.js"),
-  ...require("./stream.js"),
-  ...require("./endpoint.js"),
-  ...require("./server.js"),
-  ...require("./database/database.js"),
-  ...require("./database/document.js"),
-  ...require("./database/collection.js"),
-  ...require("./database/quota/quota.js"),
-  ...require("./database/quota/safe_int.js"),
-  ...require("./rate_limit.js"),
-  ...require("./logger.js"),
-  ...require("./events.js"),
-  ...require("./frontend.js")
-});

package/backend/dist/cjs/frontend/src/modules/request.d.ts

@@ -1,70 +0,0 @@
-/**
- * @author Daan van den Bergh
- * @copyright © 2022 - 2025 Daan van den Bergh.
- */
-import type { Server } from "../../../backend/src/server.js";
-import type { APIError } from "../../../backend/src/stream.js";
-export declare namespace Request {
-    /** The method type. */
-    export type Method = "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
-    /** The response data template base. */
-    type ResponseBodyBase = unknown | null | undefined | number | boolean | string | any[] | Record<string, any>;
-    /** The request data template base. */
-    type RequestBodyBase = unknown | null | undefined | string | Record<string, any>;
-    /**
-     * The detailed generic type for providing info for the {@link request} function.
-     */
-    export type Info<Method extends Request.Method, Endpoint extends string | RegExp, ParamsBody extends RequestBodyBase, SuccessBody extends ResponseBodyBase, ErrorBody extends ResponseBodyBase> = {
-        /** The HTTP method for the request. */
-        method: Method;
-        /** The route's endpoint or full url with domain, string or regex. */
-        endpoint: Endpoint;
-        /** The request payload (body) type. */
-        payload: ParamsBody;
-        /** The success result body type. */
-        result: SuccessBody;
-        /** The error result body type. */
-        error: ErrorBody;
-    };
-    /**
-     * Create request info from a registered endpoint.
-     */
-    export type InfoFromEndpoint<E extends Server.RegisteredEndpoint<any, any, any>, SuccessBody extends ResponseBodyBase = undefined, ErrorBody extends ResponseBodyBase = undefined> = E extends Server.RegisteredEndpoint<infer M, infer EP, infer P> ? Info<M extends undefined ? "GET" : M extends Method ? M : never, EP extends string ? EP : never, P, SuccessBody, ErrorBody> : never;
-    /** The request options. */
-    export interface Opts<Method extends Request.Method = "GET", Url extends string | RegExp = string, // use regex for backend support.
-    RequestBody extends RequestBodyBase = unknown> {
-        method?: Method;
-        url: Url;
-        data?: RequestBody;
-        json?: boolean;
-        credentials?: RequestCredentials;
-        headers?: Record<string, string>;
-    }
-    /** The returned result */
-    export type Result<SuccessBody extends ResponseBodyBase = unknown, ErrorBody extends ResponseBodyBase = unknown> = {
-        /** The request status. */
-        status: number;
-    } & ({
-        /** The api error from the backend {@link Stream.error}. */
-        error: APIError;
-        /** The error response body, always optional in case of body parsing failure. */
-        data?: ErrorBody;
-    } | {
-        /** The success response body. */
-        data: SuccessBody;
-        /** No API error from the backend {@link Stream.error} was found. */
-        error?: never;
-    });
-    /** The returned result by endpoint {@link Info} */
-    export type ResultFromInfo<Info extends Request.Info<any, any, any, any, any>> = Info extends Request.Info<any, any, any, infer S, infer E> ? Result<S, E> : never;
-    /** A promise to {@link Result}, for convenience. */
-    export type ResultPromise<SuccessBody extends ResponseBodyBase = unknown, ErrorBody extends ResponseBodyBase = unknown> = Promise<Result<SuccessBody, ErrorBody>>;
-    /** A promise to {@link Result} from endpoint {@link Info}, for convenience. */
-    export type ResultPromiseFromInfo<Info extends Request.Info<any, any, any, any, any>> = Info extends Request.Info<any, any, any, infer S, infer E> ? Promise<Result<S, E>> : never;
-    export {};
-}
-/**
- * Make a request with a specific generic typing, optionally passing
- * the request method, endpoint, request body and response body types.
- */
-export declare function request<Info extends Request.Info<any, any, any, any, any>>(options: Info extends Request.Info<infer M, infer E, infer P, any, any> ? Request.Opts<M, E, P> : never): Promise<Info extends Request.Info<any, any, any, infer S, infer E> ? Request.Result<S, E> : never>;

package/backend/dist/cjs/frontend/src/modules/request.js

@@ -1,99 +0,0 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var stdin_exports = {};
-__export(stdin_exports, {
-  request: () => request
-});
-module.exports = __toCommonJS(stdin_exports);
-async function request(options) {
-  const { method = "GET", url = null, data = null, json = true, credentials = "same-origin", headers = {} } = options;
-  if (url instanceof RegExp) {
-    throw Error("The 'url' parameter cannot be a RegExp.");
-  }
-  if (json && data != null && !headers["Content-Type"]) {
-    headers["Content-Type"] = "application/json";
-  }
-  let finalUrl = url;
-  let body;
-  if (data != null && typeof data === "object") {
-    if (method.toUpperCase() === "GET") {
-      finalUrl = `${url}?${new URLSearchParams(data).toString()}`;
-    } else {
-      body = JSON.stringify(data);
-    }
-  } else if (data != null) {
-    body = String(data);
-  }
-  const init = { method, credentials, headers };
-  if (body !== void 0)
-    init.body = body;
-  try {
-    const response = await fetch(finalUrl, init);
-    const status = response.status;
-    let payload;
-    const clone = response.clone();
-    if (json) {
-      try {
-        payload = await response.json();
-      } catch (e) {
-        console.log("[debug] Unable to parse a json from response:", await clone.text(), "- Error: ", JSON.stringify(e, null, 4));
-        console.log("[debug] Response:", response);
-        return {
-          status,
-          error: { message: `Failed to parse JSON response: ${e.message}` }
-        };
-      }
-    } else {
-      try {
-        payload = await response.text();
-      } catch (e) {
-        return {
-          status,
-          error: { message: `Failed to parse text response: ${e.message}` }
-        };
-      }
-    }
-    if (!response.ok) {
-      if (payload && typeof payload === "object" && payload.error && typeof payload.error === "object" && typeof payload.error.message === "string") {
-        return {
-          status,
-          error: {
-            message: payload.error.message,
-            type: typeof payload.error.type === "string" ? payload.error.type : void 0,
-            invalid_fields: payload.error.invalid_fields && typeof payload.error.invalid_fields === "object" && !Array.isArray(payload.error.invalid_fields) ? payload.error.invalid_fields : void 0
-          },
-          data: payload.data
-        };
-      }
-      const msg = typeof payload === "string" ? payload : payload?.error?.toString() ?? JSON.stringify(payload);
-      return {
-        status,
-        error: { message: msg },
-        data: payload.data
-      };
-    }
-    return { status, data: payload };
-  } catch (networkErr) {
-    throw networkErr;
-  }
-}
-;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  request
-});

package/backend/dist/cjs/package.json

@@ -1 +0,0 @@
-{"type":"commonjs"}

package/backend/dist/esm/backend/src/blacklist.d.ts

@@ -1,12 +0,0 @@
-/**
- * @author Daan van den Bergh
- * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
- */
-export declare class Blacklist {
-    private api_key;
-    private cache;
-    constructor({ api_key, }: {
-        api_key: string;
-    });
-    verify(ip: string): Promise<boolean>;
-}

package/backend/dist/esm/backend/src/blacklist.js

@@ -1,52 +0,0 @@
-/**
- * @author Daan van den Bergh
- * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
- */
-import * as vlib from "@vandenberghinc/vlib";
-// ---------------------------------------------------------
-// Blacklist.
-export class Blacklist {
-    api_key;
-    cache;
-    constructor({ api_key, // honey pot api key
-     }) {
-        // Checks.
-        vlib.schema.validate(arguments[0], {
-            unknown: false, throw: true,
-            schema: {
-                api_key: "string",
-            }
-        });
-        // Arguments.
-        this.api_key = api_key;
-        // Attributes.
-        this.cache = new Map();
-    }
-    // Verify, returns true on allowed and false on not allowed.
-    async verify(ip) {
-        throw new Error("Deprecated");
-        if (this.cache.has(ip)) {
-            return this.cache.get(ip);
-        }
-        let result;
-        await new Promise((resolve) => {
-            // @ts-expect-error
-            dns.resolveTxt(`${this.api_key}.${ip.split('.').reverse().join('.')}.dnsbl.httpbl.org`, (error, records) => {
-                if (error) {
-                    result = true;
-                    console.error(error);
-                }
-                else {
-                    result = true;
-                    console.log(records);
-                }
-                resolve();
-            });
-        });
-        this.cache.set(ip, result);
-        return result;
-    }
-}
-// ---------------------------------------------------------
-// Exports.
-module.exports = Blacklist;

package/backend/dist/esm/backend/src/cli.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/backend/dist/esm/backend/src/cli.js

@@ -1,211 +0,0 @@
-#!/usr/bin/env node
-/**
- * @author Daan van den Bergh
- * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
- */
-// ---------------------------------------------------------
-// Imports.
-import * as vlib from "@vandenberghinc/vlib";
-import * as vhighlight from "@vandenberghinc/vhighlight";
-import * as volt from "./index.js";
-// ---------------------------------------------------------
-// Global constants.
-const CONFIG_PATHS = [
-    "./server.json",
-    "./server.js",
-    "./server/server.json",
-    "./server/server.js",
-];
-// ---------------------------------------------------------
-// CLI.
-/**
- * Initialize the server by resolving a configuration file and returning an initialized `volt.Server`.
- * If `path` is not provided, common configuration subpaths are searched under `source`.
- * @param path Optional path to the configuration file (.json or .js). When null, defaults are searched.
- * @param source Optional base directory used when searching default config subpaths.
- */
-const initialize_server = async (path = null, source = "") => {
-    if (source == null) {
-        source = "";
-    }
-    if (path == null) {
-        path = CONFIG_PATHS.iterate((subpath) => {
-            let path = new vlib.Path(source + subpath);
-            path = path.abs();
-            if (path.exists()) {
-                return path;
-            }
-        });
-        if (path == null) {
-            throw Error(`Unable to find a configuration file, either specify a the path to the configuration file using argument "--config". Or create a configuration file at one of the following sub paths: ${CONFIG_PATHS.join(", ")}.`);
-        }
-    }
-    else {
-        path = new vlib.Path(path);
-    }
-    if (!path.exists()) {
-        throw new Error(`Server source path "${path.str()}" does not exist.`);
-    }
-    if (path.extension() == ".js") {
-        let config;
-        try {
-            config = (await import(path.abs().str())).default;
-        }
-        catch (e) {
-            throw new Error(`Failed to import "${path.str()}": ${e.message}`);
-        }
-        if (config.server) {
-            config = config.server;
-        }
-        if (config instanceof volt.Server) {
-            return { path, server: config };
-        }
-        return { path, server: new volt.Server(config) };
-    }
-    else {
-        return { path, server: new volt.Server(path.load_sync({ type: "object" })) };
-    }
-};
-/**
- * The VWeb CLI.
- * @nav CLI
- * @example
- *  $ volt --start
- */
-const cli = new vlib.CLI({
-    name: "volt",
-    description: `The volt cli. The cli must be able to access the initialized server instance or its configuration object. This can be achieved in two ways.
-
-1. A JSON file can be used to create the settings for the server.
-   The file can reside at the following project locations:
-       ./server.json
-       ./server/server.json
-
-2. Using a JavaScript configuration file.
-   The JS server file must export an object with the server's settings (parameters) or an initialized instance of volt.Server.
-   Both objects must either be exported as 'module.exports = server' or as 'module.exports = {server: server}'.
-   The file can reside at the following project locations:
-       ./server.js
-       ./server/server.js
-`,
-    version: "1.1.1",
-    commands: [
-        // Start.
-        /**
-         * Start the website (daemon).
-         * @lang CLI
-         * @parent CLI
-         * @name --start
-         * @param --source The source path to the website; the configuration file will be automatically loaded. It must reside at one of the default config sub paths. Required.
-         * @param --config The path to the configuration file. Required.
-         * @param --daemon Flag to start the service daemon. Required.
-         * @example
-         *   $ cd path/to/my/website && volt --start
-         * @example
-         *   $ volt --start --source path/to/my/website
-         * @example
-         *   $ volt --start --config path/to/my/website/config.js
-         * @docs
-         */
-        {
-            id: "--start",
-            description: "Start the website (daemon).",
-            examples: {
-                "Start": "cd path/to/my/website && volt --start",
-                "Start": "volt --start --source path/to/my/website",
-                "Start": "volt --start --config path/to/my/website/config.js",
-            },
-            args: [
-                { id: "--source", type: "string", description: `The source path to the website, the configuration file will be automatically loaded. It must reside at one of the default config sub paths.` },
-                { id: "--config", type: "string", description: `The path to the configuration file.` },
-                { id: "--daemon", type: "boolean", description: `Flag to start the service daemon.` },
-                { id: "--preview", type: "string", description: `Enable a preview browser in development mode.` },
-            ],
-            callback: async ({ source = null, config = null, daemon = false, preview = null, }) => {
-                const { path, server } = await initialize_server(config, source);
-                if (preview == null && vlib.cli.present("--preview")) {
-                    preview = "chrome";
-                }
-                if (preview) {
-                    await server.start_browser_preview(preview);
-                }
-                // Service daemon.
-                if (daemon) {
-                    // Server daemon.
-                    if (server.db.daemon) {
-                        await server.db.daemon.stop();
-                        if (server.db.daemon.exists()) {
-                            await server.db.daemon.update();
-                        }
-                        else {
-                            await server.db.daemon.create();
-                        }
-                        await server.db.daemon.start();
-                    }
-                    // Server daemon.
-                    if (!server.daemon) {
-                        cli.throw_error("The server service daemon is disabled.");
-                    }
-                    await server.daemon.stop();
-                    if (server.daemon.exists()) {
-                        await server.daemon.update();
-                    }
-                    else {
-                        await server.daemon.create();
-                    }
-                    await server.daemon.start();
-                }
-                // Development server.
-                else {
-                    if (server.file_watcher) {
-                        server.file_watcher.config = path.str();
-                    }
-                    await server.start();
-                }
-            }
-        },
-        // Stop.
-        /**
-         * Stop the website service daemon.
-         * @lang CLI
-         * @parent CLI
-         * @name --stop
-         * @param --source The source path to the website; the configuration file will be automatically loaded. It must reside at one of the default config sub paths. Required.
-         * @param --config The path to the configuration file. Required.
-         * @example
-         *   $ volt --stop
-         * @example
-         *   $ volt --stop --source path/to/my/website
-         * @example
-         *   $ volt --stop --config path/to/my/website/config.js
-         * @docs
-         */
-        {
-            id: "--stop",
-            description: "Stop the website service daemon.",
-            examples: {
-                "Stop": "cd path/to/my/website && volt --stop",
-                "Stop": "volt --stop --source path/to/my/website",
-                "Stop": "volt --stop --config path/to/my/website/config.js",
-            },
-            args: [
-                { id: "--source", type: "string", description: `The source path to the website, the configuration file will be automatically loaded. It must reside at one of the default config sub paths.` },
-                { id: "--config", type: "string", description: `The path to the configuration file.` },
-            ],
-            callback: async ({ source = null, config = null, }) => {
-                const { server } = await initialize_server(config, source);
-                // Server daemon.
-                if (server.db.daemon) {
-                    await server.db.daemon.stop();
-                }
-                // Server daemon.
-                if (!server.daemon) {
-                    cli.throw_error("The server service daemon is disabled.");
-                }
-                await server.daemon.stop();
-            }
-        },
-    ],
-});
-// Start.
-cli.start();