@mrxsys/mrx-core 2.4.0 → 2.5.0

package/dist/elysia/index.js

@@ -1,2 +0,0 @@
-// @bun
-import{h as a,i as b,j as c,k as d,l as g,m as h,n as i,o as j,p as k,q as l,r as n}from"../chunk-pt7wrvtr.js";import"../chunk-gxjax5n3.js";import"../chunk-wtfcgg9s.js";import"../chunk-df9xr1f5.js";import"../chunk-v5dfx8mh.js";import"../chunk-mwpajm9x.js";import"../chunk-9rss6865.js";import"../chunk-5nvsx7md.js";import"../chunk-n5w9cwwg.js";import"../chunk-fnb68m68.js";import"../chunk-9hj714bv.js";import"../chunk-g6a16nyh.js";import"../chunk-z00b1r18.js";import"../chunk-qndyhwdn.js";import"../chunk-4w7nd4nw.js";export{n as rateLimitPlugin,l as microservicePlugin,k as jwtPlugin,j as errorPlugin,d as dynamicDatabaseSelectorPlugin,i as crudPlugin,g as createResponse200Schema,h as createInsertBodySchema,b as createBaseSearchSchemaWithPagination,a as createBaseSearchSchema,c as advancedSearchPlugin};

package/dist/elysia/jwt.d.ts

@@ -1,46 +0,0 @@
-import { Elysia } from 'elysia';
-import { type JWTPayload } from 'jose';
-import type { JWTOptions } from './types/jwtOptions';
-/**
- * The `jwtPlugin` provides JSON Web Token (JWT) authentication capabilities for Elysia applications.
- *
- * The plugin adds two primary methods to your Elysia context:
- * - `sign()`: Generate and sign new JWTs
- * - `verify()`: Validate and decode existing JWTs
- *
- * @template Name - The name to use for JWT functionality in the context (default: 'jwt')
- * @param options - Configuration options for the JWT plugin
- *
- * @returns An Elysia plugin that adds JWT functionality to the application context
- */
-export declare const jwtPlugin: <const Name extends string = "jwt">(options: JWTOptions<Name>) => Elysia<"", {
-    decorator: { [name in Name]: {
-        sign(additionalPayload?: JWTPayload, exp?: number | string | Date): Promise<string>;
-        verify(jwt?: string): Promise<JWTPayload | false>;
-    }; } extends infer T ? { [K in keyof T]: { [name in Name]: {
-        sign(additionalPayload?: JWTPayload, exp?: number | string | Date): Promise<string>;
-        verify(jwt?: string): Promise<JWTPayload | false>;
-    }; }[K]; } : never;
-    store: {};
-    derive: {};
-    resolve: {};
-}, {
-    typebox: {};
-    error: {};
-}, {
-    schema: {};
-    standaloneSchema: {};
-    macro: {};
-    macroFn: {};
-    parser: {};
-}, {}, {
-    derive: {};
-    resolve: {};
-    schema: import("elysia").MergeSchema<{}, {}, "">;
-    standaloneSchema: import("elysia/types").PrettifySchema<{}>;
-}, {
-    derive: {};
-    resolve: {};
-    schema: {};
-    standaloneSchema: {};
-}>;

package/dist/elysia/schemas/index.d.ts

@@ -1,2 +0,0 @@
-export * from './info';
-export * from './ping';

package/dist/elysia/schemas/index.js

@@ -1,2 +0,0 @@
-// @bun
-import{$ as m,_ as f}from"../../chunk-mwpajm9x.js";import"../../chunk-4w7nd4nw.js";export{m as pingResponse200Schema,f as infoResponse200Schema};

package/dist/elysia/types/crudOptions.d.ts

@@ -1,126 +0,0 @@
-import type { Static, TObject } from '@sinclair/typebox';
-import type { Context, DefinitionBase, Elysia, EphemeralType, MetadataBase, RouteBase, RouteSchema, SingletonBase } from 'elysia';
-import type { CRUDRoutes } from './crudRoutes';
-import type { DynamicDatabaseSelectorPluginOptions } from './dynamicDatabaseSelectorPluginOptions';
-/**
- * Options for the CRUD plugin
- *
- * @template TInferedObject - The type of the object to be used in the CRUD operations extending {@link TObject}
- * @template KEnumPermission - The type of the enum for permissions extending {@link String}
- */
-export interface CrudOptions<TInferedObject extends TObject, KEnumPermission extends string> {
-    /**
-     * Optional API path prefix for all generated routes.
-     *
-     * When specified, all routes will be prefixed with this path.
-     * For example, if prefix is '/api/users', the find route will be '/api/users/count'.
-     *
-     * @defaultValue ''
-     */
-    prefix?: string;
-    /**
-     * The name of the table this CRUD interface will manage.
-     *
-     * This should match the database table name and will be used to identify
-     * the repository and models in the generated API.
-     */
-    tableName: string;
-    /**
-     * Database configuration for the CRUD operations.
-     *
-     * This can either be a string (database name) for static connections or a
-     * DynamicDatabaseSelectorPluginOptions object for dynamic database selection.
-     *
-     * @example
-     * ```typescript
-     * // Static database connection
-     * database: 'my_database'
-     *
-     * // Dynamic database selection
-     * database: {
-     *   baseDatabaseConfig: {
-     *     host: 'localhost',
-     *     port: 1433,
-     *     user: 'sa',
-     *     password: 'Password123'
-     *   },
-     *   headerKey: 'x-tenant-db'
-     * }
-     * ```
-     *
-     * @see {@link DynamicDatabaseSelectorPluginOptions}
-     *
-     */
-    database: string | DynamicDatabaseSelectorPluginOptions;
-    /**
-     * The schema to be used for the CRUD operations {@link TInferedObject}
-     * [TODO] - improve this description when working on the AND-188 ticket
-     */
-    baseSchema: TInferedObject;
-    /**
-     * Array of property names from the schema that should be required in insert operations.
-     *
-     * When specified, these properties will be required in the body of insert requests,
-     * while other properties will remain optional.
-     *
-     * @example
-     * ```typescript
-     * // Makes name and email required for insertion, while other fields remain optional
-     * insertPropertiesSchemaRequired: ['name', 'email']
-     * ```
-     */
-    insertPropertiesSchemaRequired?: (keyof Static<TInferedObject>)[];
-    /**
-     * Array of route types to include in the generated API.
-     *
-     * @see {@link CRUDRoutes}
-     *
-     * @example
-     * ```typescript
-     * // Only generate read-only routes
-     * includedRoutes: ['find', 'findOne', 'count']
-     * ```
-     */
-    includedRoutes?: CRUDRoutes[];
-    /**
-     * Array of route types to exclude from the generated API.
-     *
-     * @see {@link CRUDRoutes}
-     *
-     * @example
-     * ```typescript
-     * // Generate all routes except delete operations
-     * excludedRoutes?: ['delete', 'deleteOne']
-     * ```
-     */
-    excludedRoutes?: CRUDRoutes[];
-    /** This allows configuring permissions for each CRUD route. */
-    permissionConfig: {
-        /**
-        * A bit tricky: this should be an instance of {@link Elysia} that must have two macros
-        * called `needsOnePermission` and `needsMultiplePermissions`, each taking an array of permissions {@link KEnumPermission}
-        * as a parameter and throwing a {@link CoreError} if the user does not have the required permission.
-        */
-        permissionsPlugin: Elysia<'', SingletonBase, DefinitionBase, MetadataBase & {
-            schema: RouteSchema;
-            macro: Partial<{
-                readonly needsOnePermission: KEnumPermission[];
-                readonly needsMultiplePermissions: KEnumPermission[];
-            }>;
-            macroFn: {
-                readonly needsOnePermission: (permissions: KEnumPermission[]) => {
-                    beforeHandle: (ctx: Context) => Promise<void>;
-                };
-                readonly needsMultiplePermissions: (permissions: KEnumPermission[]) => {
-                    beforeHandle: (ctx: Context) => Promise<void>;
-                };
-            };
-        }, RouteBase, EphemeralType, EphemeralType>;
-        /**
-         * The permissions to be used for the CRUD operations
-         * @see {@link CRUDRoutes}
-         * @see {@link KEnumPermission}
-         */
-        operationsPermissions: Partial<Record<CRUDRoutes, KEnumPermission[]>>;
-    };
-}

package/dist/elysia/types/crudRoutes.d.ts

@@ -1,2 +0,0 @@
-/** CRUD Routes is a type that represents the different CRUD operations */
-export type CRUDRoutes = 'insert' | 'find' | 'findOne' | 'update' | 'updateOne' | 'delete' | 'deleteOne' | 'count';

package/dist/elysia/types/dynamicDatabaseSelectorPluginOptions.d.ts

@@ -1,30 +0,0 @@
-import type { MSSQLDatabaseOptions } from '../../database/types';
-/**
- * Options to configure the dynamic database selector plugin.
- *
- * @example
- * ```typescript
- * const options: DynamicDatabaseSelectorPluginOptions = {
- *   baseDatabaseConfig: {
- *     host: 'localhost',
- *     port: 1433,
- *     user: 'sa',
- *     password: 'Password123',
- *     encrypt: true
- *   },
- *   headerKey: 'x-database-name'
- * };
- * ```
- */
-export interface DynamicDatabaseSelectorPluginOptions {
-    /**
-     * Options for the database connection
-     * @see {@link MSSQLDatabaseOptions}
-     */
-    baseDatabaseConfig: Omit<MSSQLDatabaseOptions, 'databaseName'>;
-    /**
-     * The name of the key to be used in the header to select the database
-     * @example 'x-database-name'
-     */
-    headerKey?: string;
-}

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

@@ -1,5 +0,0 @@
-export type * from './crudOptions';
-export type * from './crudRoutes';
-export type * from './dynamicDatabaseSelectorPluginOptions';
-export type * from './jwtOptions';
-export type * from './rateLimitOptions';

package/dist/elysia/types/jwtOptions.d.ts

@@ -1,92 +0,0 @@
-import type { JWSHeaderParameters, JWTPayload } from 'jose';
-/**
- * Configuration options for the JWT plugin.
- *
- * @template TPluginName - The name to be used for accessing the JWT functionality in the Elysia context
- *
- * @example
- * ```typescript
- * const options: JWTOption = {
- *   name: 'auth',
- *   secret: process.env.JWT_SECRET || 'your-secret-key',
- *   exp: '1d',
- *   header: {
- *     alg: 'HS256',
- *     typ: 'JWT'
- *   },
- *   payload: {
- *     iss: 'my-api',
- *     aud: 'my-client'
- *   }
- * };
- * ```
- */
-export interface JWTOptions<TPluginName extends string | undefined = 'jwt'> {
-    /**
-     * JWT name to add in context with decorate.
-     *
-     * This allows you to customize how you access the JWT functionality in your
-     * route handlers. For example, if set to 'auth', you would use `auth.sign()`
-     * instead of the default `jwt.sign()`.
-     *
-     * @defaultValue 'jwt'
-     */
-    name?: TPluginName;
-    /**
-     * Secret key used to sign and verify JWTs.
-     *
-     * @example
-     * ```typescript
-     * // Using a string secret
-     * secret: 'your-very-secret-key'
-     *
-     * // Using an environment variable (recommended for production)
-     * secret: process.env.JWT_SECRET
-     * ```
-     */
-    secret: string;
-    /**
-     * JWT expiration setting. Applies as the default expiration for tokens.
-     *
-     * Controls how long tokens are valid before they expire. This setting provides
-     * a good balance between security (limiting the window of opportunity for token misuse)
-     * and user experience (not requiring frequent re-authentication).
-     *
-     * @defaultValue '15m' (15 minutes)
-     *
-     * @example
-     * ```typescript
-     * // Set tokens to expire after 1 hour
-     * exp: '1h'
-     *
-     * // Set tokens to expire at a specific date
-     * exp: new Date('2023-12-31')
-     *
-     * // Set tokens to expire after 3600 seconds (1 hour)
-     * exp: 3600
-     * ```
-     */
-    exp?: number | string | Date;
-    /**
-     * Default JWT header parameters to include in every JWT.
-     *
-     * This allows you to specify additional metadata about the token.
-     */
-    header?: JWSHeaderParameters;
-    /**
-     * Default payload values to include in every JWT.
-     *
-     * These values are merged with any additional payload provided during signing,
-     * allowing you to set standard claims that should be included in all tokens
-     * generated by your application.
-     *
-     * @example
-     * ```typescript
-     * payload: {
-     *   iss: 'my-api',           // Issuer
-     *   aud: 'my-frontend',      // Audience
-     * }
-     * ```
-     */
-    payload?: JWTPayload;
-}

package/dist/error/coreError.d.ts

@@ -1,89 +0,0 @@
-import type { CoreErrorOptions } from './types/coreErrorOptions';
-/**
- * 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

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

package/dist/error/index.js

@@ -1,2 +0,0 @@
-// @bun
-import{ra as e}from"../chunk-z00b1r18.js";import"../chunk-4w7nd4nw.js";export{e as CoreError};

package/dist/error/types/coreErrorOptions.d.ts

@@ -1,21 +0,0 @@
-/**
- * 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;
-}

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

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

package/dist/index.d.ts

@@ -1,68 +0,0 @@
-export * from './data/data';
-export * from './data/enums/dataErrorKeys';
-export * from './data/transformers/camelCase';
-export * from './data/transformers/kebabCase';
-export * from './data/transformers/pascalCase';
-export * from './data/transformers/snakeCase';
-export type * from './data/types/keyTransformer';
-export * from './database';
-export * from './database/enums/databaseErrorKeys';
-export * from './database/enums/mssqlErrorCode';
-export type * from './database/events/mssqlEventMap';
-export type * from './database/events/tableEventMap';
-export type * from './database/types/mssqlDatabaseOption';
-export type * from './database/types/mssqlEventLog';
-export type * from './database/types/queryContext';
-export * from './elysia/advancedSearch';
-export * from './elysia/crud';
-export * from './elysia/dynamicDatabaseSelector';
-export * from './elysia/error';
-export * from './elysia/jwt';
-export * from './elysia/microservice';
-export * from './elysia/ratelimit';
-export * from './elysia/enums/elysiaErrorKeys';
-export * from './elysia/enums/httpStatusCode';
-export * from './elysia/schemas/info';
-export * from './elysia/schemas/ping';
-export type * from './elysia/types/crudOptions';
-export type * from './elysia/types/crudRoutes';
-export type * from './elysia/types/dynamicDatabaseSelectorPluginOptions';
-export type * from './elysia/types/jwtOptions';
-export type * from './elysia/types/rateLimitOptions';
-export * from './error/coreError';
-export type * from './error/types/coreErrorOptions';
-export * from './logger/logger';
-export * from './logger/enums/loggerErrorKeys';
-export type * from './logger/events/loggerEvents';
-export * from './logger/strategies/consoleLogger';
-export * from './logger/strategies/fileLogger';
-export type * from './logger/types/bodiesIntersection';
-export type * from './logger/types/logLevels';
-export type * from './logger/types/logStreamChunk';
-export type * from './logger/types/loggerStrategy';
-export type * from './logger/types/strategyBody';
-export type * from './logger/types/strategyMap';
-export * from './mailer/smtp';
-export * from './mailer/enums/mailerErrorKeys';
-export type * from './mailer/types/smtpCredentials';
-export type * from './mailer/types/smtpOptions';
-export type * from './mailer/types/smtpPoolOptions';
-export * from './repository/repository';
-export type * from './repository/types/advancedSearch';
-export type * from './repository/types/orderBy';
-export type * from './repository/types/queryOptions';
-export type * from './repository/types/queryOptionsExtendPagination';
-export type * from './repository/types/queryOptionsExtendStream';
-export type * from './repository/types/selectedFields';
-export type * from './repository/types/transaction';
-export type * from './repository/types/whereClause';
-export * from './singletonManager/singletonManager';
-export * from './singletonManager/enums/singletonManagerErrorKeys';
-export * from './store/redis';
-export * from './typedEventEmitter/typedEventEmitter';
-export type * from './typedEventEmitter/types/eventMap';
-export * from './utils/env';
-export * from './utils/isIsoDateString';
-export * from './utils/stream';
-export * from './utils/enums/utilErrorKeys';
-export type * from './utils/types/streamWithAsyncIterable';

package/dist/index.js

@@ -1,2 +0,0 @@
-// @bun
-import{a as Tb}from"./chunk-dq00mfya.js";import{b as Vb}from"./chunk-89mnpfvy.js";import{c as Ub}from"./chunk-91srr77d.js";import{d as Ob,e as Pb}from"./chunk-1c7w5cx7.js";import{f as Rb}from"./chunk-h9er1sh5.js";import{g as Qb}from"./chunk-40pg2cqx.js";import{h as cb,i as fb,j as hb,k as wb,l as xb,m as zb,n as Ab,o as Bb,p as Cb,q as Hb,r as Lb}from"./chunk-pt7wrvtr.js";import{s as kb}from"./chunk-gxjax5n3.js";import{t as jb}from"./chunk-wtfcgg9s.js";import"./chunk-df9xr1f5.js";import{Y as qb,Z as Jb}from"./chunk-v5dfx8mh.js";import{$ as Gb,_ as Fb}from"./chunk-mwpajm9x.js";import{aa as Nb}from"./chunk-gtgpa8nc.js";import{ba as Mb}from"./chunk-wgq0yyqw.js";import{ca as d,da as o,ea as p,fa as v}from"./chunk-9rss6865.js";import{ga as a}from"./chunk-5nvsx7md.js";import{ha as y,ia as m,ja as l,ka as n}from"./chunk-4v4tp5qj.js";import"./database/index.js";import{la as t,ma as bb}from"./chunk-n5w9cwwg.js";import{na as s}from"./chunk-fnb68m68.js";import{oa as r,pa as i}from"./chunk-9hj714bv.js";import{qa as e}from"./chunk-g6a16nyh.js";import{ra as S}from"./chunk-z00b1r18.js";import{sa as E,ta as u}from"./chunk-qndyhwdn.js";import"./chunk-4w7nd4nw.js";export{Vb as validateEnv,Ub as utilErrorKeys,v as transformKeys,jb as singletonManagerErrorKeys,Lb as rateLimitPlugin,Gb as pingResponse200Schema,u as mssqlErrorCode,Hb as microservicePlugin,i as makeStreamAsyncIterable,Qb as mailerErrorKeys,Mb as loggerErrorKeys,Cb as jwtPlugin,r as isIsoDateString,Fb as infoResponse200Schema,Jb as httpStatusCode,p as filterByValue,o as filterByKeyInclusion,d as filterByKeyExclusion,Bb as errorPlugin,qb as elysiaErrorKeys,wb as dynamicDatabaseSelectorPlugin,E as databaseErrorKeys,a as dataErrorKeys,Ab as crudPlugin,xb as createResponse200Schema,zb as createInsertBodySchema,fb as createBaseSearchSchemaWithPagination,cb as createBaseSearchSchema,hb as advancedSearchPlugin,e as TypedEventEmitter,t as Table,n as SnakeCaseTransformer,kb as SingletonManager,Rb as SMTP,s as Repository,Tb as Redis,l as PascalCaseTransformer,bb as MSSQL,Nb as Logger,m as KebabCaseTransformer,Pb as FileLoggerStrategy,S as CoreError,Ob as ConsoleLoggerStrategy,y as CamelCaseTransformer};

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

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

package/dist/logger/enums/index.js

@@ -1,2 +0,0 @@
-// @bun
-import{ba as e}from"../../chunk-wgq0yyqw.js";import"../../chunk-4w7nd4nw.js";export{e as loggerErrorKeys};

package/dist/logger/enums/loggerErrorKeys.d.ts

@@ -1,6 +0,0 @@
-export declare const loggerErrorKeys: {
-    readonly stategyAlreadyAdded: "core.error.strategy_already_added";
-    readonly strategyNotFound: "core.error.strategy_not_found";
-    readonly noStrategyAdded: "core.error.no_strategy_added";
-    readonly loggerStrategyError: "core.error.strategy_error";
-};

package/dist/logger/events/index.d.ts

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

package/dist/logger/events/loggerEvents.d.ts

@@ -1,4 +0,0 @@
-export interface LoggerEvent {
-    error: [Error];
-    end: [];
-}

package/dist/logger/index.d.ts

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

package/dist/logger/index.js

@@ -1,2 +0,0 @@
-// @bun
-import{aa as e}from"../chunk-gtgpa8nc.js";import"../chunk-wgq0yyqw.js";import"../chunk-g6a16nyh.js";import"../chunk-z00b1r18.js";import"../chunk-4w7nd4nw.js";export{e as Logger};