@vandenberghinc/volt 1.1.2

package/backend/dist/esm/response.deprc.js

@@ -0,0 +1,275 @@
+/*
+ * Author: Daan van den Bergh
+ * Copyright: © 2022 - 2024 Daan van den Bergh.
+ */
+// ---------------------------------------------------------
+// Imports.
+const zlib = require('zlib');
+// ---------------------------------------------------------
+// Response object.
+/*  @docs
+ *  @nav: Backend
+ *  @chapter: Stream
+ *  @title: Response
+ *  @description: The response object.
+ *  @deprecated: true
+ */
+class Response {
+    constructor(res) {
+        // Arguments.
+        this.res = res;
+        // Attributes.
+        this.cookies = [];
+        // Copy default functions.
+        // this.addTrailers = this.res.addTrailers;
+        this.cork = this.res.cork.bind(this.res);
+        this.end = this.res.end.bind(this.res);
+        // this.flushHeaders = this.res.flushHeaders;
+        // this.getHeader = this.res.getHeader;
+        // this.getHeaderNames = this.res.getHeaderNames;
+        // this.getHeaders = this.res.getHeaders;
+        // this.hasHeader = this.res.hasHeader;
+        // this.removeHeader = this.res.removeHeader;
+        // this.setHeader = this.res.setHeader;
+        // this.setTimeout = this.res.setTimeout;
+        this.uncork = this.res.uncork.bind(this.res);
+        this.write = this.res.write.bind(this.res);
+        // this.writeContinue = this.res.writeContinue;
+        // this.writeEarlyHints = this.res.writeEarlyHints;
+        // this.writeHead = this.res.writeHead;
+        // this.writeProcessing = this.res.writeProcessing;
+        // Create lowercase functions.
+        this.add_trailers = this.res.addTrailers.bind(this.res);
+        this.flush_headers = this.res.flushHeaders.bind(this.res);
+        this.get_header = this.res.getHeader.bind(this.res);
+        this.get_header_names = this.res.getHeaderNames.bind(this.res);
+        this.get_headers = this.res.getHeaders.bind(this.res);
+        this.has_header = this.res.hasHeader.bind(this.res);
+        this.remove_header = this.res.removeHeader.bind(this.res);
+        this.set_header = this.res.setHeader.bind(this.res);
+        this.set_timeout = this.res.setTimeout;
+        // this.write_continue = this.res.writeContinue;
+        // this.write_early_hints = this.res.writeEarlyHints;
+        // this.write_head = this.res.writeHead;
+        // this.write_processing = this.res.writeProcessing;
+    }
+    // ---------------------------------------------------------
+    // Functions.
+    // Send a response.
+    /*  @docs:
+     *  @title: Send
+     *  @description: Send a response
+     *  @parameter:
+     *      @name: status
+     *      @description: The response status.
+     *      @type: number
+     *  @parameter:
+     *      @name: headers
+     *      @description: The response headers.
+     *      @type: object
+     *  @parameter:
+     *      @name: data
+     *      @description: The response data.
+     *      @type: undefined, string
+     *  @parameter:
+     *      @name: compress
+     *      @description: A boolean indicating if the response data should be compressed.
+     *      @type: boolean
+     *  @usage:
+     *      ...
+     *      response.send({status: 200, data: "Hello World!"});
+     */
+    send({ status = 200, headers = {}, data = null, compress = false } = {}) {
+        // Set status code.
+        this.res.statusCode = status;
+        // Set headers.
+        Object.keys(headers).forEach((key) => {
+            this.res.setHeader(key, headers[key]);
+        });
+        // Set cookies.
+        if (this.cookies.length > 0) {
+            this.res.setHeader('Set-Cookie', this.cookies);
+        }
+        // Convert data.
+        let is_json = false;
+        if (data != null && typeof data === 'object' && Buffer.isBuffer(data) === false && (data instanceof Uint8Array) === false) {
+            is_json = true;
+            data = JSON.stringify(data);
+        }
+        // @todo compress.
+        if (compress) {
+            this.res.setHeader("Content-Encoding", "gzip");
+            this.res.setHeader("Vary", "Accept-Encoding");
+            data = zlib.gzipSync(data, { level: zlib.constants.Z_BEST_COMPRESSION });
+        }
+        // Set data.
+        if (data != null) {
+            if (is_json) {
+                this.res.setHeader("Content-Type", "application/json");
+            }
+            this.res.write(data); // do not use toString() here or it will cause issues with writing binary data.
+        }
+        // End.
+        this.res.end();
+    }
+    // Send a successs response.
+    /*  @docs:
+     *  @title: Send Successs
+     *  @description: Send a response
+     *  @parameter:
+     *      @name: status
+     *      @description: The response status.
+     *      @type: number
+     *  @parameter:
+     *      @name: headers
+     *      @description: The response headers.
+     *      @type: object
+     *  @parameter:
+     *      @name: data
+     *      @description: The response data.
+     *      @type: undefined, string
+     *  @parameter:
+     *      @name: compress
+     *      @description: A boolean indicating if the response data should be compressed.
+     *      @type: boolean
+     *  @usage:
+     *      ...
+     *      response.success({data: "Hello World!"});
+     */
+    success({ status = 200, headers = {}, data = null, compress = false } = {}) {
+        return this.send({ status: status, headers: headers, data: data, compress: compress });
+    }
+    // Send an error response.
+    /*  @docs:
+     *  @title: Send Error
+     *  @description: Send an error response
+     *  @parameter:
+     *      @name: status
+     *      @description: The response status.
+     *      @type: number
+     *  @parameter:
+     *      @name: headers
+     *      @description: The response headers.
+     *      @type: object
+     *  @parameter:
+     *      @name: data
+     *      @description: The response data.
+     *      @type: undefined, string
+     *  @parameter:
+     *      @name: compress
+     *      @description: A boolean indicating if the response data should be compressed.
+     *      @type: boolean
+     *  @usage:
+     *      ...
+     *      response.error({data: "Some error occured"});
+     */
+    error({ status = 500, headers = {}, data = null, compress = false } = {}) {
+        return this.send({ status: status, headers: headers, data: data, compress: compress });
+    }
+    // Set headers.
+    /*  @docs:
+     *  @title: Set Headers
+     *  @description: Add new headers to the response data.
+     *  @parameter:
+     *      @name: headers
+     *      @description: The new response headers.
+     *      @type: object
+     *  @usage:
+     *      ...
+     *      response.set_headers({"Connection": "close"});
+     */
+    set_headers(headers = {}) {
+        if (headers == null) {
+            return null;
+        }
+        Object.keys(headers).forEach((key) => {
+            this.res.setHeader(key, headers[key]);
+        });
+    }
+    // Set a cookie.
+    /*  @docs:
+     *  @title: Set cookie.
+     *  @description: Set a cookie that will be sent with the response.
+     *  @warning: Will only be added to the response when the user uses `send()`, `success()` or `error()`.
+     *  @parameter:
+     *      @name: cookie
+     *      @description: The cookie string.
+     *      @type: string
+     *  @usage:
+     *      ...
+     *      response.set_cookie("MyCookie=Hello World;");
+     */
+    set_cookie(cookie) {
+        this.cookies.push(cookie);
+    }
+    // Set cookies.
+    /*  @docs:
+     *  @title: Set Cookies
+     *  @description: Set a cookie that will be sent with the response.
+     *  @warning: Will only be added to the response when the user uses `send()`, `success()` or `error()`.
+     *  @parameter:
+     *      @name: cookies
+     *      @description: The cookie strings.
+     *      @type: ...string
+     *  @usage:
+     *      ...
+     *      response.set_cookies("MyCookie1=Hello World;", "MyCookie2=Hello Universe;");
+     */
+    set_cookies(cookies) {
+        for (let i = 0; i < cookies.length; i++) {
+            this.cookies.push(cookies[i]);
+        }
+    }
+    // ---------------------------------------------------------
+    // Defaults.
+    // Create lowercase functions for default getters and setters.
+    get headers_sent() {
+        return this.res.headersSent;
+    }
+    set headers_sent(val) {
+        this.res.headersSent = val;
+    }
+    get send_date() {
+        return this.res.sendDate;
+    }
+    set send_date(val) {
+        this.res.sendDate = val;
+    }
+    get status_code() {
+        return this.res.statusCode;
+    }
+    set status_code(val) {
+        this.res.statusCode = val;
+    }
+    get status_message() {
+        return this.res.statusMessage;
+    }
+    set status_message(val) {
+        this.res.statusMessage = val;
+    }
+    get strict_content_length() {
+        return this.res.strictContentLength;
+    }
+    set strict_content_length(val) {
+        this.res.strictContentLength = val;
+    }
+    get writable_ended() {
+        return this.res.writableEnded;
+    }
+    set writable_ended(val) {
+        this.res.writableEnded = val;
+    }
+    get finished() {
+        return this.res.finished;
+    }
+    get writable_finished() {
+        return this.res.writableFinished;
+    }
+    set writable_finished(val) {
+        this.res.writableFinished = val;
+    }
+}
+// ---------------------------------------------------------
+// Exports.
+module.exports = Response;
+export {};

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

@@ -0,0 +1,311 @@
+import * as http from "http";
+import * as http2 from "http2";
+import * as nodemailer from 'nodemailer';
+import { vlib } from "./vinc.js";
+import { Meta } from './meta.js';
+import * as Mail from './plugins/mail.js';
+import { Status } from "./status.js";
+import { Endpoint, EndpointOptions } from "./endpoint.js";
+import { Database, Collection } from "./database.js";
+import { StaticFileWatcher, FileWatcher } from "./file_watcher.js";
+import { Users } from "./users.js";
+import { Paddle } from "./payments/paddle.js";
+import { RateLimits, RateLimitServer, RateLimitClient } from "./rate_limit.js";
+import { Blacklist } from "./blacklist.js";
+import logger, { LogSource } from "./logger.js";
+import { BrowserPreview } from "./plugins/browser.js";
+declare global {
+    type none = null | undefined;
+}
+export interface CompanyInfo {
+    name: string;
+    legal_name: string;
+    street: string;
+    house_number: string;
+    postal_code: string;
+    city: string;
+    province: string;
+    country: string;
+    country_code: string;
+    tax_id?: string;
+    type?: string;
+    icon?: string;
+    icon_path?: string;
+    stroke_icon?: string;
+    stroke_icon_path?: string;
+}
+export interface TLSConfig {
+    cert: string;
+    key: string;
+    ca?: string | null;
+    passphrase?: string;
+}
+export interface MailStyle {
+    font: string;
+    title_fg: string;
+    subtitle_fg: string;
+    text_fg: string;
+    button_fg: string;
+    footer_fg: string;
+    bg: string;
+    widget_bg: string;
+    widget_border: string;
+    button_bg: string;
+    divider_bg: string;
+}
+export interface RateLimitConfig {
+    server?: {
+        ip?: string | null;
+        port?: number;
+        https?: any | null;
+    };
+    client?: {
+        ip?: string | null;
+        port?: number;
+        url?: string | null;
+    };
+}
+export interface AdminConfig {
+    password: string | null;
+    ips: string[];
+    tokens?: Array<{
+        token: string;
+        expiration: number;
+    }>;
+}
+export interface TypeScriptConfig {
+    compiler_opts: Record<string, any>;
+    output?: string;
+}
+export interface StaticDirectory {
+    path: string;
+    endpoint?: string;
+    cache?: number | boolean;
+    endpoints_cache?: Record<string, boolean | number>;
+    exclude?: Array<string | RegExp>;
+}
+export interface MailAttachment {
+    filename: string;
+    path?: string;
+    content: any;
+}
+interface DatabaseCollections {
+}
+export declare class Server {
+    static content_type_mimes: Array<[string, string]>;
+    log: (level: number, ...args: any[]) => void;
+    error: (mode: LogSource | string | Error, ...errs: (string | Error)[]) => void;
+    static compressed_extensions: string[];
+    ip: string;
+    port: number;
+    domain: string;
+    full_domain: string;
+    source: vlib.Path;
+    is_primary: boolean;
+    statics: Array<string | StaticDirectory | vlib.Path>;
+    statics_aspect_ratios: Map<string | RegExp, any>;
+    favicon?: string;
+    enable_2fa: boolean;
+    enable_account_activation: boolean;
+    token_expiration: number;
+    google_tag?: string;
+    production: boolean;
+    multiprocessing: boolean;
+    processes: number;
+    company: CompanyInfo;
+    meta: Meta;
+    mail_style: MailStyle;
+    online: boolean;
+    offline: boolean;
+    private _keys;
+    additional_sitemap_endpoints: string[];
+    log_level: number;
+    tls?: TLSConfig;
+    file_watcher?: FileWatcher;
+    admin: AdminConfig;
+    ts: TypeScriptConfig;
+    performance: vlib.Performance;
+    csp: Record<string, string>;
+    default_headers: Record<string, string>;
+    http: http.Server;
+    https: http2.Http2SecureServer;
+    endpoints: Map<string, Endpoint>;
+    err_endpoints: Map<number, Endpoint>;
+    db: Database & DatabaseCollections;
+    _sys_db: Collection;
+    storage: Collection;
+    smtp?: nodemailer.Transporter;
+    smtp_sender?: string | [string, string];
+    rate_limit?: RateLimitServer | RateLimitClient;
+    blacklist?: Blacklist;
+    private _hash_key;
+    keys: Record<string, string>;
+    private _on_start;
+    private _on_stop;
+    browser_preview?: BrowserPreview;
+    static_file_watcher: StaticFileWatcher;
+    is_file_watcher: boolean;
+    daemon?: vlib.Daemon;
+    private _stop_tscompiler_watcher?;
+    users: Users;
+    payments: Paddle;
+    status: typeof Status;
+    rate_limits: typeof RateLimits;
+    logger: typeof logger;
+    constructor({ ip, port, domain, is_primary, source, database, statics, favicon, company, meta, tls, smtp, mail_style, rate_limit, keys, payments, default_headers, google_tag, token_expiration, enable_2fa, enable_account_activation, production, multiprocessing, processes, file_watcher, offline, additional_sitemap_endpoints, log_level, daemon, admin, ts, browser_preview, }: {
+        ip?: string;
+        port?: number;
+        domain: string;
+        is_primary?: boolean;
+        source: string;
+        database?: string | Record<string, any> | boolean;
+        statics?: Array<string | vlib.Path | StaticDirectory>;
+        favicon?: string;
+        company: CompanyInfo;
+        meta?: Meta | Record<string, any>;
+        tls?: TLSConfig;
+        smtp?: nodemailer.TransportOptions;
+        mail_style?: Partial<MailStyle>;
+        rate_limit?: RateLimitConfig;
+        keys?: Array<string | {
+            name: string;
+            length: number;
+        }>;
+        payments?: any;
+        default_headers?: Record<string, any> | null;
+        google_tag?: string;
+        token_expiration?: number;
+        enable_2fa?: boolean;
+        enable_account_activation?: boolean;
+        production?: boolean;
+        multiprocessing?: boolean;
+        processes?: number | null;
+        file_watcher?: FileWatcher | Record<string, any> | boolean;
+        offline?: boolean;
+        additional_sitemap_endpoints?: string[];
+        log_level?: number;
+        daemon?: Record<string, any> | boolean;
+        admin?: Partial<AdminConfig>;
+        ts?: Partial<TypeScriptConfig>;
+        browser_preview?: string;
+    });
+    get_content_type(extension: string): string;
+    set_log_level(level: number): void;
+    generate_crypto_key(length?: number): string;
+    hmac(key: string, data: string, algo?: string): string;
+    _hmac(data: string): string;
+    hash(data: string | object, algo?: string): string;
+    private _init_default_headers;
+    private _set_header_defaults;
+    private _find_endpoint;
+    private _create_default_endpoints;
+    private _create_sitemap;
+    private _create_robots_txt;
+    private _create_admin_endpoint;
+    private _initialize_statics;
+    _init_ts(): Promise<void>;
+    initialize(): Promise<void>;
+    _serve(http2_stream?: http2.ServerHttp2Stream, headers?: Record<string, string>, req?: http.IncomingMessage | http2.Http2ServerRequest, res?: http.ServerResponse | http2.Http2ServerResponse): Promise<void>;
+    start(): Promise<void>;
+    on_start(callback: ({ forked }: {
+        forked: boolean;
+    }) => void | Promise<void>): void;
+    stop(): Promise<void>;
+    on_stop(callback: () => void | Promise<void>): void;
+    fetch_status(type?: "object" | "string"): Promise<string | Record<string, any>>;
+    add_csp(key: string, value?: null | string | string[]): void;
+    remove_csp(key: string, value?: null | string): void;
+    del_csp(key: string): void;
+    generate_tls_key({ path, organization_unit, ec }: {
+        path: string;
+        organization_unit?: string;
+        ec?: boolean;
+    }): Promise<void>;
+    endpoint(...endpoints: (none | Endpoint | EndpointOptions | (none | EndpointOptions | Endpoint)[])[]): this;
+    error_endpoint(status_code: number, endpoint: Endpoint | EndpointOptions): this;
+    send_mail({ sender, recipients, subject, body, attachments, }: {
+        sender?: string | [string, string];
+        recipients?: (string | [string, string])[];
+        subject?: string;
+        body?: string | Mail.MailElement;
+        attachments?: (string | vlib.Path | MailAttachment)[];
+    }): Promise<void>;
+    on_delete_user({ uid }: {
+        uid: string | string[];
+    }): Promise<void>;
+    on_payment({ product, payment }: {
+        product: any;
+        payment: any;
+    }): Promise<void>;
+    on_subscription({ product, payment }: {
+        product: any;
+        payment: any;
+    }): Promise<void>;
+    on_cancellation({ payment, line_items }: {
+        payment: any;
+        line_items: any[];
+    }): Promise<void>;
+    on_refund({ payment, line_items }: {
+        payment: any;
+        line_items: any[];
+    }): Promise<void>;
+    on_failed_refund({ payment, line_items }: {
+        payment: any;
+        line_items: any[];
+    }): Promise<void>;
+    on_chargeback({ payment, line_items }: {
+        payment: any;
+        line_items: any[];
+    }): Promise<void>;
+    on_failed_chargeback({ payment, line_items }: {
+        payment: any;
+        line_items: any[];
+    }): Promise<void>;
+    _mail_template({ max_width, children, }: {
+        max_width?: number;
+        children?: any[];
+    }): any;
+    _render_mail_payment_line_items({ payment, line_items, show_total_due }: {
+        payment: any;
+        line_items: any[];
+        show_total_due?: boolean;
+    }): any[];
+    on_2fa_mail({ code, username, email, date, ip, device }: {
+        code: string;
+        username: string;
+        email: string;
+        date: string;
+        ip: string;
+        device: string;
+    }): any;
+    on_payment_mail({ payment }: {
+        payment: any;
+    }): any;
+    on_failed_payment_mail({ payment }: {
+        payment: any;
+    }): any;
+    on_cancellation_mail({ payment, line_items }: {
+        payment: any;
+        line_items: any[];
+    }): any;
+    on_failed_cancellation_mail({ payment }: {
+        payment: any;
+    }): any;
+    on_refund_mail({ payment, line_items }: {
+        payment: any;
+        line_items: any[];
+    }): any;
+    on_failed_refund_mail({ payment, line_items }: {
+        payment: any;
+        line_items: any[];
+    }): any;
+    on_chargeback_mail({ payment, line_items }: {
+        payment: any;
+        line_items: any[];
+    }): any;
+    on_failed_chargeback_mail({ payment, line_items }: {
+        payment: any;
+        line_items: any[];
+    }): any;
+}
+export default Server;