@vandenberghinc/volt 1.2.6 → 1.2.8

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

@@ -0,0 +1,185 @@
+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, {
+  ImageEndpoint: () => ImageEndpoint
+});
+module.exports = __toCommonJS(stdin_exports);
+var import_sharp = __toESM(require("sharp"));
+var import_endpoint = require("./endpoint.js");
+class ImageEndpoint extends import_endpoint.Endpoint {
+  // Cache the original and transformed image data in memory.
+  // static cache_in_memory = false;
+  // Supported image extensions.
+  static supported_images = /* @__PURE__ */ new Set([
+    ".jpg",
+    ".jpeg",
+    ".png",
+    ".webp",
+    ".gif",
+    ".tif",
+    ".tiff",
+    ".svg",
+    ".heif",
+    ".avif"
+  ]);
+  i_path;
+  i_type;
+  // private i_data?: Buffer;
+  is_image_endpoint;
+  /**
+   * A cache of all transformed image paths, mapped by cache id.
+   * We use a cached path since `stat` will be used inside the Stream.send() method.
+   * Since this is cached in the Path object, it will be efficient.
+   */
+  transformed_cache = /* @__PURE__ */ new Map();
+  /**
+   * Construct an image endpoint.
+   * @docs
+   */
+  constructor({ endpoint, path, cache = true, _is_static = true, rate_limit = void 0 }) {
+    super({
+      method: "GET",
+      endpoint,
+      compress: false,
+      cache,
+      params: {
+        "type": { type: "string", default: null },
+        "width": { type: ["number", "string"], default: null },
+        "height": { type: ["number", "string"], default: null },
+        "aspect_ratio": { type: "string", default: null }
+      },
+      rate_limit,
+      file_path: path,
+      _is_static
+    });
+    this.i_path = path.abs();
+    this.i_type = this.i_path.extension().substr(1);
+    this.is_image_endpoint = true;
+    this.callback = async (stream, params) => {
+      if ((params.type == null || this.i_type === params.type) && params.width == null && params.height == null) {
+        return stream.send({
+          status: 200,
+          from_file: this.i_path.str()
+        });
+      }
+      const cache_id = `${this.route.method}:${this.route.endpoint_str}:${params.width == null ? "" : params.width}.${params.height == null ? "" : params.height}.${params.type == null ? this.i_type : params.type}`.replaceAll("/", "_");
+      let cache_path;
+      if (this.transformed_cache.has(cache_id)) {
+        cache_path = this.transformed_cache.get(cache_id);
+      } else {
+        cache_path = this.server.endpoint_cache_dir.join(cache_id);
+        this.transformed_cache.set(cache_id, cache_path);
+      }
+      if (cache_path.exists()) {
+        return stream.send({
+          status: 200,
+          from_file: cache_path
+        });
+      }
+      if (this.i_type === params.type) {
+        params.type = null;
+      }
+      const data = await this.transform(params.type, params.width, params.height, params.aspect_ratio);
+      await cache_path.save(data);
+      return stream.send({
+        status: 200,
+        from_file: cache_path
+      });
+    };
+  }
+  // Transform image.
+  async transform(type = null, width = null, height = null, aspect_ratio = true) {
+    const img = (0, import_sharp.default)(this.i_path.str());
+    let metadata;
+    if (width != null || height != null) {
+      let parsed_width;
+      let parsed_height;
+      if (typeof width === "string") {
+        let last_char = width.charAt(width.length - 1);
+        if (last_char === "%" || last_char === "x") {
+          if (metadata === void 0) {
+            metadata = await img.metadata();
+          }
+          if (last_char === "x") {
+            parsed_width = parseInt(String(metadata.width * parseFloat(width)));
+          } else {
+            parsed_width = parseInt(String(metadata.width * (parseFloat(width) / 100)));
+          }
+        } else {
+          parsed_width = parseInt(width);
+        }
+      } else if (typeof width === "number") {
+        parsed_width = parseInt(String(width));
+      }
+      if (typeof height === "string") {
+        let last_char = height.charAt(height.length - 1);
+        if (last_char === "%" || last_char === "x") {
+          if (metadata === void 0) {
+            metadata = await img.metadata();
+          }
+          if (last_char === "x") {
+            parsed_height = parseInt(String(metadata.height * parseFloat(height)));
+          } else {
+            parsed_height = parseInt(String(metadata.height * (parseFloat(height) / 100)));
+          }
+        } else {
+          parsed_height = parseInt(height);
+        }
+      } else if (typeof height === "number") {
+        parsed_height = parseInt(String(height));
+      }
+      const opts = {
+        width: parsed_width,
+        height: parsed_height
+      };
+      if (aspect_ratio === "false" || aspect_ratio === false) {
+        opts.fit = "fill";
+      }
+      img.resize(opts);
+    }
+    if (type != null) {
+      img.toFormat(type);
+    }
+    return img.toBuffer();
+  }
+  // Get aspect ratio.
+  async get_aspect_ratio() {
+    try {
+      const metadata = await (0, import_sharp.default)(this.file_path?.str()).metadata();
+      return `${metadata.width} / ${metadata.height}`;
+    } catch (err) {
+      this.server?.log.error(`Unable to determine the aspect ratio of image ${this.file_path}: `, err);
+      return null;
+    }
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ImageEndpoint
+});

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

@@ -0,0 +1,23 @@
+/**
+ * @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 "./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/index.js

@@ -0,0 +1,70 @@
+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("./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("./events.js"),
+  ...require("./frontend.js")
+});

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

@@ -0,0 +1,5 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
+ */
+export {};

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

@@ -0,0 +1,15 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var stdin_exports = {};
+module.exports = __toCommonJS(stdin_exports);

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

@@ -0,0 +1,112 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
+ */
+/** Nested types for the {@link Meta} class. */
+export declare namespace Meta {
+    /**
+     * Options for constructing a {@link Meta} object.
+     *
+     * @docs
+     */
+    interface Opts {
+        /** The author's name. */
+        author?: string;
+        /** The page's title. */
+        title?: string;
+        /** The page's description. */
+        description?: string;
+        /** The page's image source. */
+        image?: string;
+        /** The robots rules. */
+        robots?: string;
+        /** The used charset. */
+        charset?: string;
+        /** The viewport settings. */
+        viewport?: string;
+        /** The url to the favicon. */
+        favicon?: string;
+    }
+}
+/**
+ * The meta information class for HTML endpoints.
+ *
+ * @nav Endpoints
+ * @docs
+ */
+export declare class Meta {
+    author?: string;
+    title?: string;
+    description?: string;
+    image?: string;
+    robots: string;
+    charset: string;
+    viewport: string;
+    favicon: string;
+    /**
+     * Construct a meta information object.
+     * @docs
+     */
+    constructor({ author, title, description, image, robots, charset, viewport, favicon, }?: Meta.Opts);
+    /**
+     * Create a copy of the current meta object without any references.
+     * @param override - The meta constructor arguments to override.
+     * @docs
+     */
+    copy(override?: Partial<Meta.Opts>): Meta;
+    /**
+     * Update the author property.
+     * @return Returns the current {@link Meta} instance for chaining.
+     * @docs
+     */
+    set_author(value: string | undefined): this;
+    /**
+     * Update the title property.
+     * @return Returns the current {@link Meta} instance for chaining.
+     * @docs
+     */
+    set_title(value: string | undefined): this;
+    /**
+     * Update the description property.
+     * @return Returns the current {@link Meta} instance for chaining.
+     * @docs
+     */
+    set_description(value: string | undefined): this;
+    /**
+     * Update the image property.
+     * @return Returns the current {@link Meta} instance for chaining.
+     * @docs
+     */
+    set_image(value: string | undefined): this;
+    /**
+     * Update the robots property.
+     * @return Returns the current {@link Meta} instance for chaining.
+     * @docs
+     */
+    set_robots(value: string): this;
+    /**
+     * Update the charset property.
+     * @return Returns the current {@link Meta} instance for chaining.
+     * @docs
+     */
+    set_charset(value: string): this;
+    /**
+     * Update the viewport property.
+     * @return Returns the current {@link Meta} instance for chaining.
+     * @docs
+     */
+    set_viewport(value: string): this;
+    /**
+     * Update the favicon property.
+     * @return Returns the current {@link Meta} instance for chaining.
+     * @docs
+     */
+    set_favicon(value: string): this;
+    /**
+     * Get the meta information as a plain object.
+     * @docs
+     */
+    obj(): Meta.Opts;
+    build_html(domain?: string | null): string;
+}
+export default Meta;

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

@@ -0,0 +1,181 @@
+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, {
+  Meta: () => Meta,
+  default: () => stdin_default
+});
+module.exports = __toCommonJS(stdin_exports);
+class Meta {
+  author;
+  title;
+  description;
+  image;
+  robots;
+  charset;
+  viewport;
+  favicon;
+  /**
+   * Construct a meta information object.
+   * @docs
+   */
+  constructor({ author, title, description, image, robots = "index, follow", charset = "UTF-8", viewport = "width=device-width, initial-scale=1", favicon = "/favicon.ico" } = {}) {
+    this.author = author;
+    this.title = title;
+    this.description = description;
+    this.image = image;
+    this.robots = robots;
+    this.charset = charset;
+    this.viewport = viewport;
+    this.favicon = favicon;
+  }
+  /**
+   * Create a copy of the current meta object without any references.
+   * @param override - The meta constructor arguments to override.
+   * @docs
+   */
+  copy(override = {}) {
+    return new Meta({
+      author: this.author,
+      title: this.title,
+      description: this.description,
+      image: this.image,
+      robots: this.robots,
+      charset: this.charset,
+      viewport: this.viewport,
+      favicon: this.favicon,
+      ...override
+    });
+  }
+  /**
+   * Update the author property.
+   * @return Returns the current {@link Meta} instance for chaining.
+   * @docs
+   */
+  set_author(value) {
+    this.author = value;
+    return this;
+  }
+  /**
+   * Update the title property.
+   * @return Returns the current {@link Meta} instance for chaining.
+   * @docs
+   */
+  set_title(value) {
+    this.title = value;
+    return this;
+  }
+  /**
+   * Update the description property.
+   * @return Returns the current {@link Meta} instance for chaining.
+   * @docs
+   */
+  set_description(value) {
+    this.description = value;
+    return this;
+  }
+  /**
+   * Update the image property.
+   * @return Returns the current {@link Meta} instance for chaining.
+   * @docs
+   */
+  set_image(value) {
+    this.image = value;
+    return this;
+  }
+  /**
+   * Update the robots property.
+   * @return Returns the current {@link Meta} instance for chaining.
+   * @docs
+   */
+  set_robots(value) {
+    this.robots = value;
+    return this;
+  }
+  /**
+   * Update the charset property.
+   * @return Returns the current {@link Meta} instance for chaining.
+   * @docs
+   */
+  set_charset(value) {
+    this.charset = value;
+    return this;
+  }
+  /**
+   * Update the viewport property.
+   * @return Returns the current {@link Meta} instance for chaining.
+   * @docs
+   */
+  set_viewport(value) {
+    this.viewport = value;
+    return this;
+  }
+  /**
+   * Update the favicon property.
+   * @return Returns the current {@link Meta} instance for chaining.
+   * @docs
+   */
+  set_favicon(value) {
+    this.favicon = value;
+    return this;
+  }
+  /**
+   * Get the meta information as a plain object.
+   * @docs
+   */
+  obj() {
+    return {
+      author: this.author,
+      title: this.title,
+      description: this.description,
+      image: this.image,
+      robots: this.robots,
+      charset: this.charset,
+      viewport: this.viewport,
+      favicon: this.favicon
+    };
+  }
+  // Build meta headers.
+  build_html(domain = null) {
+    let html = "";
+    html += `<meta charset='${this.charset}'>`;
+    html += `<meta name='viewport' content='${this.viewport}'/>`;
+    html += `<title id='__page_title'>${this.title}</title>`;
+    html += `<meta name='author' content='${this.author}'/>`;
+    html += `<meta name='description' content='${this.description}'/>`;
+    html += `<meta property='og:title' content='${this.title}'/>`;
+    html += `<meta property='og:description' content='${this.description}'/>`;
+    html += `<meta property='og:image' content='${this.image}'/>`;
+    if (domain) {
+      html += `<meta property="og:url" content="${domain}"/>`;
+    }
+    html += `<meta property="og:type" content="website"/>`;
+    html += `<meta name='twitter:card' content='summary_large_image'/>`;
+    html += `<meta name='twitter:title' content='${this.title}'/>`;
+    html += `<meta name='twitter:description' content='${this.description}'/>`;
+    html += `<meta name='twitter:image' content='${this.image}'/>`;
+    html += `<meta name='robots' content='${this.robots}'>`;
+    html += `<link rel='icon' href='${this.favicon}' type='image/x-icon'/>`;
+    return html;
+  }
+}
+var stdin_default = Meta;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Meta
+});