@vandenberghinc/volt 1.1.2

package/.vrepo

@@ -0,0 +1,28 @@
+{
+    "ssh": {
+    	"remotes": [
+    		{
+	            "alias": "dev.vinc", 
+	            "destination": "/Volumes/persistance/private/dev/vinc/volt/", 
+	            "enabled": true
+	        },
+	        {
+	            "alias": "vinc", 
+	            "destination": "/vserver/storages/vinc/volt/", 
+	            "enabled": true
+	        }
+	    ]
+    },
+    "git": {
+	    "username": "vandenberghinc",
+	    "email": "admin@vandenberghinc.com",
+	    "remotes": [
+	        {
+	            "remote": "origin",
+	            "branch": "main",
+	            "destination": "git@github.com:vandenberghinc/volt.git",
+	            "enabled": true
+	        }
+	    ]
+	}
+}

package/.vscode/tasks.json

@@ -0,0 +1,87 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Build",
+            "type": "shell",
+            "command": "npm",
+            "args": [
+                "run",
+                "compile",
+            ],
+            // "command": "npx",
+            // "args": [
+            //     "tsc",
+            //     "-p",
+            //     "./tsconfig.json"
+            // ],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "presentation": {
+                "reveal": "silent",
+                "panel": "dedicated",
+                "clear": true
+            },
+            "problemMatcher": "$tsc"
+        },
+        {
+            "label": "Test",
+            "type": "shell",
+            "command": "npm",
+            "args": [
+                "run",
+                "test"
+            ],
+            // "command": "node",
+            // "args": [
+            //     "./dist/libris/libris/unit_tests/run.js"
+            // ],
+            "group": {
+                "kind": "test",
+                "isTestCommand": true
+            },
+            "presentation": {
+                "reveal": "always",
+                "panel": "dedicated",
+                "clear": true
+            },
+            "problemMatcher": []
+        },
+        {
+            "label": "Run",
+            "type": "shell",
+            "command": "npm",
+            "args": [
+                "run",
+                "start"
+            ],
+            "group": {
+                "kind": "test",
+                "isTestCommand": true
+            },
+            "presentation": {
+                "reveal": "always",
+                "panel": "dedicated",
+                "clear": true
+            },
+            "problemMatcher": []
+        },
+        {
+            "label": "Build and Test",
+            "dependsOrder": "sequence",
+            "dependsOn": [
+                "Build",
+                "Test"
+            ],
+            "group": "test",
+            "presentation": {
+                "reveal": "always",
+                "panel": "dedicated",
+                "clear": true
+            },
+            "problemMatcher": []
+        }
+    ]
+}

package/README.md

@@ -0,0 +1,67 @@
+<p align="center">
+<img src="https://github.com/vandenberghinc/volt/blob/main/dev/media/icon/stroke.png?raw=true" alt="Volt" width="500">
+</p>  
+Creating websites with ease.
+<br><br>
+<p align="center">
+    <img src="https://img.shields.io/badge/version-{{VERSION}}-orange" alt="Bergh-Encryption">
+    <img src="https://img.shields.io/badge/std-c++20-orange" alt="Bergh-Encryption">
+    <img src="https://img.shields.io/badge/status-maintained-forestgreen" alt="Bergh-Encryption">
+    <img src="https://img.shields.io/badge/dependencies-vlib-yellow" alt="Bergh-Encryption">
+    <img src="https://img.shields.io/badge/OS-MacOS & Linux-blue" alt="Bergh-Encryption">
+</p> 
+<br><br>
+
+## In Development.
+This library is currently still in development.
+<br><br>
+
+<!-- ## Documentation.
+Full documentation at [Github Pages](https://vandenberghinc.github.io/volt). -->
+
+## Project hierarchy.
+When creating a website using volt it is advised to create the following project hierarchy. The `server.js` file must either reside at `./server/server.js` or at `./server.js`.
+```
+website/
+    server/
+        config.js - Use this file to define the Server object and export it in module.exports either under the attribute `server` or as the export itself.
+        endpoints.js - For example use this file to define your endpoints.
+        server.js - Use this file to import the server and require all endpoints. This file must be named server.js for the volt cli.
+    ...
+```
+
+###### config.js
+```javascript
+// Imports.
+const volt = require("@vandenberghinc/volt");
+
+// Initialize the server.
+const server = new volt.Server({
+    ...
+})
+
+// Exports.
+module.exports = {
+    server,
+};
+```
+
+###### endpoints.js
+```javascript
+// Imports.
+const {server} = require("./config.js");
+
+// Create an endpoint.
+server.endpoint({
+    ...
+});
+```
+
+###### server.js
+```javascript
+// Imports.
+const {server} = require("./config.js");
+
+// Load endpoints.
+require("./endpoints.js");
+```

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

@@ -0,0 +1,10 @@
+export declare class Blacklist {
+    private api_key;
+    private cache;
+    constructor({ api_key, // honey pot api key
+    _server, }: {
+        api_key: string;
+        _server: any;
+    });
+    verify(ip: string): Promise<boolean>;
+}

package/backend/dist/cjs/blacklist.js

@@ -0,0 +1,53 @@
+"use strict";
+/*
+ * Author: Daan van den Bergh
+ * Copyright: © 2022 - 2024 Daan van den Bergh.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Blacklist = void 0;
+const _vinc_1 = require("./vinc.js");
+// ---------------------------------------------------------
+// Blacklist.
+class Blacklist {
+    api_key;
+    cache;
+    constructor({ api_key, // honey pot api key
+    _server, }) {
+        // Checks.
+        _vinc_1.vlib.Scheme.verify({ object: arguments[0], check_unknown: true, scheme: {
+                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.Blacklist = Blacklist;
+// ---------------------------------------------------------
+// Exports.
+module.exports = Blacklist;

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

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

package/backend/dist/cjs/cli.js

@@ -0,0 +1,263 @@
+#!/usr/bin/env node
+"use strict";
+/*
+ * Author: Daan van den Bergh
+ * Copyright: © 2022 - 2024 Daan van den Bergh.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+// ---------------------------------------------------------
+// Imports.
+const _vinc_1 = require("./vinc.js");
+const _vinc_2 = require("./vinc.js");
+const volt = __importStar(require("./volt.js"));
+// ---------------------------------------------------------
+// Global constants.
+const CONFIG_PATHS = [
+    "./server.json",
+    "./server.js",
+    "./server/server.json",
+    "./server/server.js",
+];
+// ---------------------------------------------------------
+// CLI.
+// Initialize the server.
+const initialize_server = async (path = null, source = "") => {
+    if (source == null) {
+        source = "";
+    }
+    if (path == null) {
+        path = CONFIG_PATHS.iterate((subpath) => {
+            let path = new _vinc_1.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 _vinc_1.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 Promise.resolve(`${path.abs().str()}`).then(s => __importStar(require(s)))).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" })) };
+    }
+};
+// Create the CLI.
+/*  @docs:
+ *  @lang: CLI
+ *  @name: CLI
+ *  @title: VWeb CLI
+ *  @description: The VWeb CLI.
+ *  @usage:
+ *      @CLI:
+ *          $ volt --start
+ */
+const cli = new _vinc_1.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.
+        /*  @docs:
+         *  @lang: CLI
+         *  @parent: CLI
+         *  @title: Start
+         *  @name: --start
+         *  @description: Start the website (daemon).
+         *  @param:
+         *      @name: --source
+         *      @type: string
+         *      @desc: The source path to the website, the configuration file will be automatically loaded. It must reside at one of the default config sub paths.
+         *      @con_required: true
+         *  @param:
+         *      @name: --config
+         *      @type: string
+         *      @desc: The path to the configuration file.
+         *      @con_required: true
+         *  @param:
+         *      @name: --daemon
+         *      @type: boolean
+         *      @desc: Flag to start the service daemon.
+         *      @con_required: true
+         *  @usage:
+         *      @CLI:
+         *          $ cd path/to/my/website && volt --start
+         *          $ volt --start --source path/to/my/website
+         *          $ volt --start --config path/to/my/website/config.js
+         */
+        {
+            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 && _vinc_1.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.
+        /*  @docs:
+         *  @lang: CLI
+         *  @parent: CLI
+         *  @title: Stop
+         *  @name: --stop
+         *  @description: Stop the website service daemon.
+         *  @param:
+         *      @name: --source
+         *      @type: string
+         *      @desc: The source path to the website, the configuration file will be automatically loaded. It must reside at one of the default config sub paths.
+         *      @con_required: true
+         *  @param:
+         *      @name: --config
+         *      @type: string
+         *      @desc: The path to the configuration file.
+         *      @con_required: true
+         *  @usage:
+         *      @CLI:
+         *          $ volt --stop
+         *          $ volt --stop --source path/to/my/website
+         *          $ volt --stop --config path/to/my/website/config.js
+         */
+        {
+            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();