velocious 1.0.430 → 1.0.431

package/src/jobs/mail-delivery.js

@@ -0,0 +1,22 @@
+// @ts-check
+
+import VelociousJob from "../background-jobs/job.js"
+import {deliverPayload} from "../mailer.js"
+
+/**
+ * Background job for delivering mailer payloads.
+ */
+export default class MailDeliveryJob extends VelociousJob {
+  /**
+   * Runs perform.
+   * @param {import("../mailer.js").MailerDeliveryPayload} [payload] - Mail delivery payload.
+   * @returns {Promise<void>} - Resolves when complete.
+   */
+  async perform(payload) {
+    if (!payload) {
+      throw new Error(`Missing mail delivery payload. Got: ${String(payload)}`)
+    }
+
+    await deliverPayload(payload)
+  }
+}

package/src/logger/base-logger.js

@@ -0,0 +1,34 @@
+// @ts-check
+
+/**
+ * Base logger interface for custom logger implementations.
+ */
+export default class BaseLogger {
+  /**
+   * Convert the logger into an output config.
+   * @param {object} args - Options object.
+   * @param {import("../configuration.js").default | undefined} [args.configuration] - Configuration instance.
+   * @returns {import("../configuration-types.js").LoggingOutputConfig} - Output config.
+   */
+  toOutputConfig(args) {
+    void args
+    if (typeof this.write !== "function") {
+      throw new Error("BaseLogger#write must be implemented")
+    }
+
+    return {
+      output: this,
+      levels: /** @type {?} */ (this).levels
+    }
+  }
+
+  /**
+   * Write a log payload.
+   * @param {import("../configuration-types.js").LoggingOutputPayload} payload - Log payload.
+   * @returns {Promise<void> | void} - Resolves when complete.
+   */
+  write(payload) {
+    void payload
+    throw new Error("BaseLogger#write must be implemented")
+  }
+}

package/src/logger/console-logger.js

@@ -0,0 +1,28 @@
+// @ts-check
+
+import BaseLogger from "./base-logger.js"
+import LoggerConsoleOutput from "./outputs/console-output.js"
+
+/** Console logger configuration wrapper. */
+export default class ConsoleLogger extends BaseLogger {
+  /**
+   * Runs constructor.
+   * @param {object} [args] - Options object.
+   * @param {Array<"debug-low-level" | "debug" | "info" | "warn" | "error">} [args.levels] - Levels to emit.
+   */
+  constructor({levels} = {}) {
+    super()
+    this.levels = levels
+  }
+
+  /**
+   * Runs to output config.
+   * @returns {import("../configuration-types.js").LoggingOutputConfig} - Output config.
+   */
+  toOutputConfig() {
+    return {
+      output: new LoggerConsoleOutput(),
+      levels: this.levels
+    }
+  }
+}

package/src/logger/file-logger.js

@@ -0,0 +1,36 @@
+// @ts-check
+
+import BaseLogger from "./base-logger.js"
+import LoggerFileOutput from "./outputs/file-output.js"
+
+/** File logger configuration wrapper. */
+export default class FileLogger extends BaseLogger {
+  /**
+   * Runs constructor.
+   * @param {object} args - Options object.
+   * @param {string} args.path - File path to write to.
+   * @param {Array<"debug-low-level" | "debug" | "info" | "warn" | "error">} [args.levels] - Levels to emit.
+   */
+  constructor({path, levels}) {
+    super()
+    this.path = path
+    this.levels = levels
+  }
+
+  /**
+   * Runs to output config.
+   * @param {object} args - Options object.
+   * @param {import("../configuration.js").default | undefined} [args.configuration] - Configuration instance.
+   * @returns {import("../configuration-types.js").LoggingOutputConfig} - Output config.
+   */
+  toOutputConfig({configuration} = {}) {
+    return {
+      output: new LoggerFileOutput({
+        configuration,
+        getConfiguration: () => configuration,
+        filePath: this.path
+      }),
+      levels: this.levels
+    }
+  }
+}

package/src/logger/outputs/array-output.js

@@ -0,0 +1,50 @@
+// @ts-check
+
+/**
+ * LoggingOutputPayload type.
+  @typedef {import("../../configuration-types.js").LoggingOutputPayload} LoggingOutputPayload */
+
+/** Logger array output. */
+export default class LoggerArrayOutput {
+  _limit = 2000
+  /**
+   * Levels.
+    @type {import("../../configuration-types.js").LogLevel[]} */
+  levels = ["debug", "info", "warn", "error"]
+  /**
+   * Logs.
+    @type {LoggingOutputPayload[]} */
+  _logs = []
+
+  /**
+   * Runs constructor.
+   * @param {object} [args] - Options object.
+   * @param {number} [args.limit] - Max number of log entries to keep.
+   */
+  constructor({limit = 2000} = {}) {
+    const normalizedLimit = typeof limit === "number" && Number.isFinite(limit) ? limit : 2000
+    this._limit = normalizedLimit
+  }
+
+  /**
+   * Runs write.
+   * @param {LoggingOutputPayload} payload - Log payload.
+   */
+  async write({level, message, subject, timestamp}) {
+    if (this._limit <= 0) return
+
+    this._logs.push({level, message, subject, timestamp})
+
+    if (this._logs.length > this._limit) {
+      this._logs.splice(0, this._logs.length - this._limit)
+    }
+  }
+
+  /**
+   * Runs get logs.
+   * @returns {LoggingOutputPayload[]} - Stored log entries.
+   */
+  getLogs() {
+    return this._logs.slice()
+  }
+}

package/src/logger/outputs/console-output.js

@@ -0,0 +1,32 @@
+// @ts-check
+
+/**
+ * LoggingOutputPayload type.
+  @typedef {import("../../configuration-types.js").LoggingOutputPayload} LoggingOutputPayload */
+
+/** Logger console output. */
+export default class LoggerConsoleOutput {
+  /**
+   * Runs write.
+   * @param {LoggingOutputPayload} payload - Log payload.
+   */
+  async write({level, message}) {
+    if (level === "error") {
+      console.error(message)
+      return
+    }
+
+    if (level === "warn") {
+      console.warn(message)
+      return
+    }
+
+    if (level === "debug" || level === "debug-low-level") {
+      const debugLogger = typeof console.debug === "function" ? console.debug : console.log
+      debugLogger(message)
+      return
+    }
+
+    console.log(message)
+  }
+}

package/src/logger/outputs/file-output.js

@@ -0,0 +1,55 @@
+// @ts-check
+
+/**
+ * LoggingOutputPayload type.
+  @typedef {import("../../configuration-types.js").LoggingOutputPayload} LoggingOutputPayload */
+
+/** Logger file output. */
+export default class LoggerFileOutput {
+  /**
+   * Configuration.
+    @type {import("../../configuration.js").default | undefined} */
+  _configuration = undefined
+  /**
+   * File path.
+    @type {string | undefined} */
+  _filePath = undefined
+  /**
+   * Get configuration.
+    @type {(() => import("../../configuration.js").default | undefined) | undefined} */
+  _getConfiguration = undefined
+
+  /**
+   * Runs constructor.
+   * @param {object} args - Options object.
+   * @param {import("../../configuration.js").default} [args.configuration] - Configuration instance.
+   * @param {() => import("../../configuration.js").default | undefined} [args.getConfiguration] - Configuration resolver.
+   * @param {string} args.filePath - File path.
+   */
+  constructor({configuration, getConfiguration, filePath}) {
+    this._configuration = configuration
+    this._getConfiguration = getConfiguration
+    this._filePath = filePath
+  }
+
+  /**
+   * Runs write.
+   * @param {LoggingOutputPayload} payload - Log payload.
+   */
+  async write({message}) {
+    if (!this._filePath) return
+
+    const configuration = this._configuration || this._getConfiguration?.()
+
+    if (!configuration || typeof configuration.getEnvironmentHandler !== "function") return
+
+    const environmentHandler = configuration.getEnvironmentHandler()
+
+    if (!environmentHandler || typeof environmentHandler.writeLogToFile !== "function") return
+
+    await environmentHandler.writeLogToFile({
+      filePath: this._filePath,
+      message
+    })
+  }
+}

package/src/logger/outputs/stdout-output.js

@@ -0,0 +1,64 @@
+// @ts-check
+
+import useEnvSense from "env-sense/build/use-env-sense.js"
+
+/**
+ * LoggingOutputPayload type.
+  @typedef {import("../../configuration-types.js").LoggingOutputPayload} LoggingOutputPayload */
+
+const {isBrowser} = useEnvSense()
+const isNodeRuntime = typeof process !== "undefined" && Boolean(process.versions?.node)
+
+/**
+ * Runs write to stream.
+ * @param {import("node:stream").Writable | undefined} stream - Stream to write to.
+ * @param {string} message - Message to write.
+ * @returns {Promise<void>} - Resolves when complete.
+ */
+function writeToStream(stream, message) {
+  return new Promise((resolve) => {
+    if (!stream || typeof stream.write !== "function") {
+      resolve()
+      return
+    }
+
+    stream.write(`${message}\n`, "utf8", () => resolve())
+  })
+}
+
+/** Logger stdout/stderr output. */
+export default class LoggerStdoutOutput {
+  /**
+   * Runs write.
+   * @param {LoggingOutputPayload} payload - Log payload.
+   */
+  async write({level, message}) {
+    if (!isBrowser && isNodeRuntime) {
+      if (level === "warn" || level === "error") {
+        await writeToStream(process.stderr, message)
+      } else {
+        await writeToStream(process.stdout, message)
+      }
+
+      return
+    }
+
+    if (level === "error") {
+      console.error(message)
+      return
+    }
+
+    if (level === "warn") {
+      console.warn(message)
+      return
+    }
+
+    if (level === "debug" || level === "debug-low-level") {
+      const debugLogger = typeof console.debug === "function" ? console.debug : console.log
+      debugLogger(message)
+      return
+    }
+
+    console.log(message)
+  }
+}