@mrxsys/mrx-core 2.3.3-canary-20250514-a17e993

package/dist/error/coreError.d.ts

@@ -0,0 +1,109 @@
+/**
+ * Represents the options for the Core error.
+ */
+export interface CoreErrorOptions<T = unknown> {
+    /**
+     * The error message describing what went wrong.
+     */
+    message?: string;
+    /**
+     * A unique key identifying the type of error, useful for localization or error handling.
+     */
+    key?: string;
+    /**
+     * The HTTP status code associated with the error, typically used in API responses.
+     */
+    httpStatusCode?: number;
+    /**
+     * The cause of the error, which can be an original error or additional context.
+     */
+    cause?: T;
+}
+/**
+ * A custom error class that extends the native {@link Error} class, providing additional properties
+ * such as a unique identifier, error key, HTTP status code, and cause.
+ *
+ * @template T - The type of the cause of the error, which can be any object or error.
+ *
+ * @example
+ * The following example demonstrates how to throw and catch a CoreError.
+ * ```typescript
+ * try {
+ *   throw new CoreError({
+ *     message: 'An error occurred',
+ *     key: 'example.error',
+ *     httpStatusCode: 400,
+ *     cause: new Error('Original error')
+ *   });
+ * } catch (error) {
+ *   if (error instanceof CoreError) {
+ *     console.error(`Error UUID: ${error.uuid}`);
+ *     console.error(`Error Date: ${error.date}`);
+ *     console.error(`Error Key: ${error.key}`);
+ *     console.error(`HTTP Status Code: ${error.httpStatusCode}`);
+ *     console.error(`Cause: ${error.cause}`);
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * The following example demonstrates how to create a CoreError with a custom cause type.
+ * ```typescript
+ * const coreError = new CoreError<{ foo: string }>({
+ *     message: 'Custom error with cause',
+ *     key: 'core-package.error.custom_error',
+ *     httpStatusCode: 500,
+ *     cause: { foo: 'bar' },
+ * });
+ * console.log(coreError.cause); // { foo: 'bar' }
+ * ```
+ */
+export declare class CoreError<const T = unknown> extends Error {
+    /**
+     * The cause of the error, typically used to store the original error or additional context.
+     */
+    readonly cause: T | undefined;
+    /**
+     * The unique identifier of the error, automatically generated using UUID v7.
+     * This identifier is particularly useful for tracking errors in logs.
+     */
+    private readonly _uuid;
+    /**
+     * The date when the error was created, automatically set to the current date and time.
+     */
+    private readonly _date;
+    /**
+     * A unique key identifying the type of error, useful for localization or error handling.
+     */
+    private readonly _key;
+    /**
+     * The HTTP status code associated with the error, typically used in API responses.
+     */
+    private readonly _httpStatusCode;
+    /**
+     * Creates a new instance of the CoreError class.
+     *
+     * @param coreErrorOptions - The options for the Core error. ({@link CoreErrorOptions})
+     */
+    constructor(coreErrorOptions?: Readonly<CoreErrorOptions<T>>);
+    /**
+     * Gets the unique identifier of the error.
+     * @returns The UUID of the error.
+     */
+    get uuid(): string;
+    /**
+     * Gets the date when the error was created.
+     * @returns The creation date of the error.
+     */
+    get date(): Date;
+    /**
+     * Gets the error key, which identifies the type of error.
+     * @returns The key associated with the error.
+     */
+    get key(): string;
+    /**
+     * Gets the HTTP status code associated with the error.
+     * @returns The HTTP status code.
+     */
+    get httpStatusCode(): number;
+}

package/dist/error/index.d.ts

@@ -0,0 +1 @@
+export * from './coreError';

package/dist/error/index.js

@@ -0,0 +1,2 @@
+// @bun
+import{_ as e}from"../chunk-6sa6shm6.js";import"../chunk-rr6e20n5.js";export{e as CoreError};

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+export * from './database';
+export * from './database/enums';
+export * from './database/events';
+export type * from './database/types';
+export * from './elysia';
+export * from './elysia/enums';
+export * from './elysia/schemas';
+export type * from './elysia/types';
+export * from './error';
+export * from './mailer';
+export * from './mailer/enums';
+export type * from './mailer/types';
+export * from './repository';
+export type * from './repository/types';
+export * from './store';
+export * from './utils';
+export * from './utils/enums';
+export type * from './utils/types';

package/dist/index.js

@@ -0,0 +1,2 @@
+// @bun
+import"./utils/enums/index.js";import"./error/index.js";import{a as P}from"./mailer/index.js";import"./mailer/enums/index.js";import{b as O}from"./chunk-s3xqwymw.js";import"./repository/index.js";import{c as Q}from"./store/index.js";import{d as S}from"./utils/index.js";import{e as R}from"./chunk-0pft81dh.js";import"./database/index.js";import"./database/enums/index.js";import"./database/events/index.js";import{f as v,g as w,h as z,i as B,j as C,k as F,l as G,m as H,n as I,o as L,p as N}from"./elysia/index.js";import"./chunk-kn1300vm.js";import{U as n,V as q}from"./chunk-wggj590m.js";import{W as j,X as k}from"./chunk-t411e41y.js";import{Y as g,Z as h}from"./chunk-7map0v4a.js";import{_ as c}from"./chunk-6sa6shm6.js";import{$ as d,aa as u}from"./chunk-dppgkz92.js";import{ba as D,ca as E}from"./chunk-yeyzc9n2.js";import"./elysia/enums/index.js";import{da as A,ea as M}from"./chunk-nntk6mwx.js";import"./elysia/schemas/index.js";import{fa as J,ga as K}from"./chunk-xcz2fxzt.js";import"./chunk-rr6e20n5.js";export{S as validateEnv,R as utilKeyError,E as tableEvent,N as rateLimitPlugin,K as pingResponse200Schema,j as operators,D as mssqlEvent,u as mssqlErrorCode,L as microservicePlugin,h as makeStreamAsyncIterable,O as mailerKeyError,I as jwtPlugin,g as isIsoDateString,J as infoResponse200Schema,M as httpStatusCode,H as errorPlugin,A as elysiaKeyError,B as dynamicDatabaseSelectorPlugin,d as databaseKeyError,G as crudPlugin,C as createResponse200Schema,F as createInsertBodySchema,w as createBaseSearchSchemaWithPagination,v as createBaseSearchSchema,z as advancedSearchPlugin,n as Table,P as SMTP,k as Repository,Q as Redis,q as MSSQL,c as CoreError};

package/dist/mailer/enums/index.d.ts

@@ -0,0 +1 @@
+export * from './mailerKeyError';

package/dist/mailer/enums/index.js

@@ -0,0 +1,2 @@
+// @bun
+import{b as e}from"../../chunk-s3xqwymw.js";import"../../chunk-rr6e20n5.js";export{e as mailerKeyError};

package/dist/mailer/enums/mailerKeyError.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Mailer error key is a list of errors in the mailer context.
+ * Each property represents a specific mailer error scenario.
+ */
+export declare const mailerKeyError: {
+    /** Error when failing to connect to SMTP server. */
+    readonly smtpConnectionError: "core.error.mailer.smtp.connection_error";
+    /** Error when SMTP server is not connected. */
+    readonly smtpNotConnected: "core.error.mailer.smtp.not_connected";
+    /** Error when SMTP server is already connected. */
+    readonly smtpAlreadyConnected: "core.error.mailer.smtp.already_connected";
+};

package/dist/mailer/index.d.ts

@@ -0,0 +1 @@
+export * from './smtp';

package/dist/mailer/index.js

@@ -0,0 +1,2 @@
+// @bun
+import{b as z}from"../chunk-s3xqwymw.js";import{_ as q}from"../chunk-6sa6shm6.js";import"../chunk-rr6e20n5.js";import{createTransport as B}from"nodemailer";class D{_config;_transporter=null;constructor(x){this._config={port:587,secure:!1,...x}}async connect(){if(this._transporter)throw new q({key:z.smtpAlreadyConnected,message:"SMTP transporter is already connected."});this._transporter=B({host:this._config.host,port:this._config.port,secure:this._config.secure,auth:{user:this._config.credentials.user,pass:this._config.credentials.pass},pool:!0,maxConnections:this._config.pool?.maxConnections??5});try{await this._transporter.verify()}catch(x){throw new q({key:z.smtpConnectionError,message:"An error occurred while connecting to the SMTP server",cause:x})}}disconnect(){if(this._transporter)this._transporter.close(),this._transporter=null}async sendMail(x){if(!this._transporter)throw new q({key:z.smtpNotConnected,message:"SMTP transporter is not connected."});return this._transporter.sendMail(x)}}export{D as SMTP};export{D as a};

package/dist/mailer/smtp.d.ts

@@ -0,0 +1,62 @@
+import { type SendMailOptions } from 'nodemailer';
+import type { SMTPOptions } from './types/smtpOptions';
+/**
+ * The `SMTP` class manages the connection and operations with an SMTP server.
+ *
+ * This class provides methods to connect, disconnect, and send emails using
+ * the Nodemailer library. It supports connection pooling and error handling ({@link CoreError}).
+ *
+ * @example
+ * ```typescript
+ * const smtp = new SMTP({
+ *   host: 'smtp.example.com',
+ *   credentials: { user: 'user', pass: 'pass' }
+ * });
+ * await smtp.connect();
+ * await smtp.sendMail({ to: 'dest@example.com', subject: 'Hello', text: 'Hi!' });
+ * smtp.disconnect();
+ * ```
+ */
+export declare class SMTP {
+    /**
+     * The configuration options for the SMTP connection.
+     */
+    private readonly _config;
+    /**
+     * The Nodemailer transporter instance for sending emails.
+     */
+    private _transporter;
+    /**
+     * Creates an instance of the SMTP class.
+     *
+     * @param config - The configuration options for the SMTP connection. (see {@link SMTPOptions}).
+     */
+    constructor(config: SMTPOptions);
+    /**
+     * Establishes a pool of connections to the SMTP server and verifies the connection.
+     *
+     * This method creates a Nodemailer transporter using the configuration provided to the class.
+     * It enables connection pooling for efficient resource usage and sets the maximum number of
+     * concurrent connections as specified in the configuration (default: 5).
+     *
+     * @throws ({@link CoreError}): If the transporter is already connected. ({@link mailerKeyError.smtpAlreadyConnected})
+     * @throws ({@link CoreError}): If the connection or verification fails. ({@link mailerKeyError.smtpConnectionError})
+     */
+    connect(): Promise<void>;
+    /**
+     * Closes the SMTP connection and releases resources.
+     *
+     * If the transporter is not connected, this method does nothing.
+     */
+    disconnect(): void;
+    /**
+     * Sends an email using the established SMTP connection.
+     *
+     * @param options - The mail options, such as recipient, subject, and content.
+     *
+     * @throws ({@link CoreError}) - If the transporter is not connected. ({@link mailerKeyError.smtpNotConnected})
+     *
+     * @returns A promise resolving to the result of the send operation.
+     */
+    sendMail(options: SendMailOptions): Promise<unknown>;
+}

package/dist/mailer/types/index.d.ts

@@ -0,0 +1,3 @@
+export type * from './smtpCredentials';
+export type * from './smtpOptions';
+export type * from './smtpPoolOptions';

package/dist/mailer/types/index.js

@@ -0,0 +1 @@
+// @bun

package/dist/mailer/types/smtpCredentials.d.ts

@@ -0,0 +1,10 @@
+export interface SMTPCredentials {
+    /**
+     * The username for SMTP authentication.
+     */
+    user: string;
+    /**
+     * The password for SMTP authentication.
+     */
+    pass: string;
+}

package/dist/mailer/types/smtpOptions.d.ts

@@ -0,0 +1,26 @@
+import type { SMTPCredentials } from './smtpCredentials';
+import type { SMTPPoolOptions } from './smtpPoolOptions';
+export interface SMTPOptions {
+    /**
+     * The hostname or IP address of the SMTP server.
+     */
+    host: string;
+    /**
+     * The port number to connect to.
+     * @defaultValue 587
+     */
+    port?: number;
+    /**
+     * Whether to use a secure (TLS) connection.
+     * @defaultValue false
+     */
+    secure?: boolean;
+    /**
+     * The credentials for SMTP authentication.
+     */
+    credentials: SMTPCredentials;
+    /**
+     * Optional pool configuration.
+     */
+    pool?: SMTPPoolOptions;
+}

package/dist/mailer/types/smtpPoolOptions.d.ts

@@ -0,0 +1,7 @@
+export interface SMTPPoolOptions {
+    /**
+     * The maximum number of concurrent SMTP connections.
+     * @defaultValue 5
+     */
+    maxConnections?: number;
+}

package/dist/repository/index.d.ts

@@ -0,0 +1 @@
+export * from './repository';

package/dist/repository/index.js

@@ -0,0 +1,2 @@
+// @bun
+import{W as e,X as f}from"../chunk-t411e41y.js";import"../chunk-7map0v4a.js";import"../chunk-6sa6shm6.js";import"../chunk-dppgkz92.js";import"../chunk-rr6e20n5.js";export{e as operators,f as Repository};