@vandenberghinc/volt 1.2.6 → 1.2.8

package/.libris/config.json

@@ -0,0 +1,82 @@
+[
+    {
+        "project": "volt",
+        "version": "1.1.1",
+        "entry": [
+            "backend/src/index.ts"
+        ],
+        "exclude": [
+            "**/*.js"
+        ],
+        "sort": "ascending",
+        "favicon": "https://raw.githubusercontent.com/vandenberghinc/volt/master/dev/media/icon/favicon.ico",
+        "icon": {
+            "dark": "https://raw.githubusercontent.com/vandenberghinc/volt/master/dev/media/icon/stroke.png",
+            "light": "https://raw.githubusercontent.com/vandenberghinc/volt/master/dev/media/icon/stroke.dark.png",
+            "height": 30
+        },
+        "theme": {
+            "dark": {
+                "extends": "dark",
+                "primary": "linear-gradient(70deg, #F9DB4A 0%, #EA682C 100%)",
+                "primary_base": "#EA682C",
+                "bg": "#1C232E"
+            },
+            "light": {
+                "extends": "light",
+                "primary": "linear-gradient(70deg, #F9DB4A 0%, #EA682C 100%)",
+                "primary_base": "#EA682C"
+            }
+        },
+        "sections": [
+            {
+                "text": "Node.js",
+                "url": "/docs/miF5fmUsvgaEcqLP/volt/latest"
+            },
+            {
+                "text": "Browser",
+                "url": "/docs/miF5fmUsvgaEcqLP/volt-web/latest"
+            }
+        ]
+    },
+    {
+        "project": "volt-web",
+        "version": "1.1.1",
+        "entry": [
+            "frontend/src/index.ts"
+        ],
+        "exclude": [
+            "**/*.js"
+        ],
+        "sort": "ascending",
+        "favicon": "https://raw.githubusercontent.com/vandenberghinc/volt/master/dev/media/icon/favicon.ico",
+        "icon": {
+            "dark": "https://raw.githubusercontent.com/vandenberghinc/volt/master/dev/media/icon/stroke.png",
+            "light": "https://raw.githubusercontent.com/vandenberghinc/volt/master/dev/media/icon/stroke.dark.png",
+            "height": 30
+        },
+        "theme": {
+            "dark": {
+                "extends": "dark",
+                "primary": "linear-gradient(70deg, #F9DB4A 0%, #EA682C 100%)",
+                "primary_base": "#EA682C",
+                "bg": "#1C232E"
+            },
+            "light": {
+                "extends": "light",
+                "primary": "linear-gradient(70deg, #F9DB4A 0%, #EA682C 100%)",
+                "primary_base": "#EA682C"
+            }
+        },
+        "sections": [
+            {
+                "text": "Node.js",
+                "url": "/docs/miF5fmUsvgaEcqLP/volt/latest"
+            },
+            {
+                "text": "Browser",
+                "url": "/docs/miF5fmUsvgaEcqLP/volt-web/latest"
+            }
+        ]
+    }
+]

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

@@ -0,0 +1,12 @@
+/**
+ * @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/cjs/backend/src/blacklist.js

@@ -0,0 +1,78 @@
+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 __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, {
+  Blacklist: () => Blacklist
+});
+module.exports = __toCommonJS(stdin_exports);
+var vlib = __toESM(require("@vandenberghinc/vlib"));
+class Blacklist {
+  api_key;
+  cache;
+  constructor({
+    api_key
+    // honey pot api key
+  }) {
+    vlib.schema.validate(arguments[0], {
+      unknown: false,
+      throw: true,
+      schema: {
+        api_key: "string"
+      }
+    });
+    this.api_key = api_key;
+    this.cache = /* @__PURE__ */ 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) => {
+      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;
+  }
+}
+module.exports = Blacklist;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Blacklist
+});

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

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

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

@@ -0,0 +1,198 @@
+#!/usr/bin/env node
+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 __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 __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 vlib = __toESM(require("@vandenberghinc/vlib"));
+var vhighlight = __toESM(require("@vandenberghinc/vhighlight"));
+var volt = __toESM(require("./index.js"));
+const CONFIG_PATHS = [
+  "./server.json",
+  "./server.js",
+  "./server/server.json",
+  "./server/server.js"
+];
+const initialize_server = async (path = null, source = "") => {
+  if (source == null) {
+    source = "";
+  }
+  if (path == null) {
+    path = CONFIG_PATHS.iterate((subpath) => {
+      let path2 = new vlib.Path(source + subpath);
+      path2 = path2.abs();
+      if (path2.exists()) {
+        return path2;
+      }
+    });
+    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" })) };
+  }
+};
+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);
+        }
+        if (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();
+          }
+          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();
+        } 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);
+        if (server.db.daemon) {
+          await server.db.daemon.stop();
+        }
+        if (!server.daemon) {
+          cli.throw_error("The server service daemon is disabled.");
+        }
+        await server.daemon.stop();
+      }
+    }
+  ]
+});
+cli.start();