@mrxsys/mrx-core 2.6.0 → 2.8.0

package/package.json

@@ -1,15 +1,33 @@
 {
 	"name": "@mrxsys/mrx-core",
-	"version": "2.6.0",
+	"version": "2.8.0",
 	"author": "Ruby",
-	"description": " Core provides a set of tools to help you build a microservice",
-	"type": "module",
-	"license": "MIT",
-	"keywords": [
-		"mrxsys",
-		"mrxsys-core",
-		"core"
-	],
+	"devDependencies": {
+		"@eslint/js": "^9.34.0",
+		"@sinclair/typebox": "0.34.40",
+		"@stylistic/eslint-plugin": "^5.2.3",
+		"@types/bun": "^1.2.21",
+		"@types/nodemailer": "^7.0.1",
+		"elysia": "^1.3.20",
+		"eslint": "^9.34.0",
+		"globals": "^16.3.0",
+		"ioredis": "^5.7.0",
+		"jose": "^6.0.13",
+		"knex": "^3.1.0",
+		"mssql": "^11.0.1",
+		"nodemailer": "^7.0.5",
+		"typescript-eslint": "^8.41.0"
+	},
+	"peerDependencies": {
+		"@sinclair/typebox": "0.34.40",
+		"elysia": "^1.3.20",
+		"ioredis": "^5.7.0",
+		"jose": "^6.0.13",
+		"knex": "^3.1.0",
+		"mssql": "^11.0.1",
+		"nodemailer": "^7.0.5",
+		"typescript": "^5.9.2"
+	},
 	"exports": {
 		"./errors": "./dist/errors/index.js",
 		"./errors/enums": "./dist/errors/enums/index.js",
@@ -22,6 +40,9 @@
 		"./modules/database/enums": "./dist/modules/database/enums/index.js",
 		"./modules/database/events": "./dist/modules/database/events/index.js",
 		"./modules/database/types": "./dist/modules/database/types/index.js",
+		"./modules/elysia/cache": "./dist/modules/elysia/cache/index.js",
+		"./modules/elysia/cache/types": "./dist/modules/elysia/cache/types/index.js",
+		"./modules/elysia/cache/utils": "./dist/modules/elysia/cache/utils/index.js",
 		"./modules/elysia/crud": "./dist/modules/elysia/crud/index.js",
 		"./modules/elysia/crud/types": "./dist/modules/elysia/crud/types/index.js",
 		"./modules/elysia/crudSchema": "./dist/modules/elysia/crudSchema/index.js",
@@ -31,13 +52,17 @@
 		"./modules/elysia/dbResolver/enums": "./dist/modules/elysia/dbResolver/enums/index.js",
 		"./modules/elysia/dbResolver/types": "./dist/modules/elysia/dbResolver/types/index.js",
 		"./modules/elysia/error": "./dist/modules/elysia/error/index.js",
-		"./modules/elysia/jwt": "./dist/modules/elysia/jwt/index.js",
-		"./modules/elysia/jwt/enums": "./dist/modules/elysia/jwt/enums/index.js",
-		"./modules/elysia/jwt/types": "./dist/modules/elysia/jwt/types/index.js",
 		"./modules/elysia/microservice": "./dist/modules/elysia/microservice/index.js",
-		"./modules/elysia/ratelimit": "./dist/modules/elysia/ratelimit/index.js",
-		"./modules/elysia/ratelimit/enums": "./dist/modules/elysia/ratelimit/enums/index.js",
-		"./modules/elysia/ratelimit/types": "./dist/modules/elysia/ratelimit/types/index.js",
+		"./modules/elysia/rateLimit": "./dist/modules/elysia/rateLimit/index.js",
+		"./modules/elysia/rateLimit/enums": "./dist/modules/elysia/rateLimit/enums/index.js",
+		"./modules/elysia/rateLimit/types": "./dist/modules/elysia/rateLimit/types/index.js",
+		"./modules/jwt": "./dist/modules/jwt/index.js",
+		"./modules/jwt/enums": "./dist/modules/jwt/enums/index.js",
+		"./modules/jwt/utils": "./dist/modules/jwt/utils/index.js",
+		"./modules/kvStore/enums": "./dist/modules/kvStore/enums/index.js",
+		"./modules/kvStore/ioredis": "./dist/modules/kvStore/ioredis/index.js",
+		"./modules/kvStore/memory": "./dist/modules/kvStore/memory/index.js",
+		"./modules/kvStore/types": "./dist/modules/kvStore/types/index.js",
 		"./modules/logger": "./dist/modules/logger/index.js",
 		"./modules/logger/enums": "./dist/modules/logger/enums/index.js",
 		"./modules/logger/events": "./dist/modules/logger/events/index.js",
@@ -50,71 +75,16 @@
 		"./modules/repository/types": "./dist/modules/repository/types/index.js",
 		"./modules/singletonManager": "./dist/modules/singletonManager/index.js",
 		"./modules/singletonManager/enums": "./dist/modules/singletonManager/enums/index.js",
+		"./modules/totp": "./dist/modules/totp/index.js",
+		"./modules/totp/enums": "./dist/modules/totp/enums/index.js",
+		"./modules/totp/types": "./dist/modules/totp/types/index.js",
+		"./modules/totp/utils": "./dist/modules/totp/utils/index.js",
 		"./modules/typedEventEmitter": "./dist/modules/typedEventEmitter/index.js",
 		"./modules/typedEventEmitter/types": "./dist/modules/typedEventEmitter/types/index.js",
 		"./utils": "./dist/utils/index.js",
 		"./utils/enums": "./dist/utils/enums/index.js",
 		"./utils/types": "./dist/utils/types/index.js"
 	},
-	"scripts": {
-		"build": "bun builder.ts",
-		"docs": "bunx typedoc --tsconfig tsconfig.build.json",
-		"fix-lint": "eslint --fix ./source",
-		"lint": "eslint ./source",
-		"start": "bun build/index.js",
-		"test:integration": "bun test --timeout 5800 $(find test/integration -name '*.spec.ts')",
-		"test:unit": "bun test --timeout 5800 --coverage $(find test/unit -name '*.spec.ts')",
-		"test": "bun test --coverage --timeout 5500"
-	},
-	"devDependencies": {
-		"@eslint/js": "^9.32.0",
-		"@sinclair/typebox": "0.34.38",
-		"@stylistic/eslint-plugin": "^5.2.2",
-		"@types/bun": "^1.2.19",
-		"@types/nodemailer": "^6.4.17",
-		"elysia": "^1.3.8",
-		"eslint": "^9.32.0",
-		"globals": "^16.3.0",
-		"ioredis": "^5.7.0",
-		"jose": "^6.0.12",
-		"knex": "^3.1.0",
-		"mssql": "^11.0.1",
-		"nodemailer": "^7.0.5",
-		"typescript-eslint": "^8.38.0"
-	},
-	"peerDependencies": {
-		"@sinclair/typebox": "0.34.38",
-		"elysia": "^1.3.8",
-		"ioredis": "^5.7.0",
-		"jose": "^6.0.12",
-		"knex": "^3.1.0",
-		"mssql": "^11.0.1",
-		"nodemailer": "^7.0.5",
-		"typescript": "^5.9.2"
-	},
-	"peerDependenciesMeta": {
-		"@sinclair/typebox": {
-			"optional": true
-		},
-		"elysia": {
-			"optional": true
-		},
-		"ioredis": {
-			"optional": true
-		},
-		"jose": {
-			"optional": true
-		},
-		"knex": {
-			"optional": true
-		},
-		"mssql": {
-			"optional": true
-		},
-		"nodemailer": {
-			"optional": true
-		}
-	},
 	"changelog": {
 		"types": {
 			"feat": {
@@ -166,5 +136,46 @@
 			"tagMessage": "v{{newVersion}}",
 			"tagBody": "v{{newVersion}}"
 		}
-	}
+	},
+	"description": " Core provides a set of tools to help you build a microservice",
+	"keywords": [
+		"mrxsys",
+		"mrxsys-core",
+		"core"
+	],
+	"license": "MIT",
+	"peerDependenciesMeta": {
+		"@sinclair/typebox": {
+			"optional": true
+		},
+		"elysia": {
+			"optional": true
+		},
+		"ioredis": {
+			"optional": true
+		},
+		"jose": {
+			"optional": true
+		},
+		"knex": {
+			"optional": true
+		},
+		"mssql": {
+			"optional": true
+		},
+		"nodemailer": {
+			"optional": true
+		}
+	},
+	"scripts": {
+		"build": "bun builder.ts",
+		"docs": "bunx typedoc --tsconfig tsconfig.build.json",
+		"fix-lint": "eslint --fix ./source",
+		"lint": "eslint ./source",
+		"start": "bun build/index.js",
+		"test:integration": "bun test --timeout 5800 $(find test/integration -name '*.spec.ts')",
+		"test:unit": "bun test --timeout 5800 --coverage $(find test/unit -name '*.spec.ts')",
+		"test": "bun test --coverage --timeout 5500"
+	},
+	"type": "module"
 }

package/dist/chunk-cqw9xq4y.js

@@ -1,7 +0,0 @@
-// source/modules/elysia/jwt/enums/jwtErrorKeys.ts
-var JWT_ERROR_KEYS = {
-  JWT_SIGN_ERROR: "elysia.jwt.error.sign_error",
-  JWT_SECRET_NOT_FOUND: "elysia.jwt.error.secret_not_found"
-};
-
-export { JWT_ERROR_KEYS };

package/dist/chunk-twaga0fp.js

@@ -1,6 +0,0 @@
-// source/modules/elysia/ratelimit/enums/ratelimitErrorKeys.ts
-var RATELIMIT_ERROR_KEYS = {
-  RATELIMIT_EXCEEDED: "elysia.ratelimit.error.exceeded"
-};
-
-export { RATELIMIT_ERROR_KEYS };

package/dist/modules/elysia/jwt/enums/index.d.ts

@@ -1 +0,0 @@
-export { JWT_ERROR_KEYS } from './jwtErrorKeys';

package/dist/modules/elysia/jwt/enums/index.js

@@ -1,7 +0,0 @@
-// @bun
-import {
-  JWT_ERROR_KEYS
-} from "../../../../chunk-cqw9xq4y.js";
-export {
-  JWT_ERROR_KEYS
-};

package/dist/modules/elysia/jwt/enums/jwtErrorKeys.d.ts

@@ -1,4 +0,0 @@
-export declare const JWT_ERROR_KEYS: {
-    readonly JWT_SIGN_ERROR: "elysia.jwt.error.sign_error";
-    readonly JWT_SECRET_NOT_FOUND: "elysia.jwt.error.secret_not_found";
-};

package/dist/modules/elysia/jwt/index.d.ts

@@ -1 +0,0 @@
-export { jwt } from './jwt';

package/dist/modules/elysia/jwt/index.js

@@ -1,77 +0,0 @@
-// @bun
-import {
-  JWT_ERROR_KEYS
-} from "../../../chunk-cqw9xq4y.js";
-import {
-  HttpError
-} from "../../../chunk-683sda6e.js";
-import"../../../chunk-9nw6qekv.js";
-import"../../../chunk-vknq69e0.js";
-
-// source/modules/elysia/jwt/jwt.ts
-import { Elysia } from "elysia";
-import {
-  SignJWT,
-  jwtVerify
-} from "jose";
-var jwt = (options) => {
-  if (!options.secret)
-    throw new HttpError({
-      message: JWT_ERROR_KEYS.JWT_SECRET_NOT_FOUND,
-      httpStatusCode: "INTERNAL_SERVER_ERROR"
-    });
-  const encodedKey = new TextEncoder().encode(options.secret);
-  const contextKeyName = options.jwtKeyName ?? "jwt";
-  const defaultAlgorithm = "HS256";
-  const defaultExpiration = "15m";
-  return new Elysia({
-    name: "jwt",
-    seed: options
-  }).decorate(contextKeyName, {
-    async sign(additionalPayload, expiration = options.exp ?? defaultExpiration) {
-      const jwtId = crypto.randomUUID();
-      const finalPayload = {
-        iss: "elysia-jwt-plugin",
-        aud: "elysia-application",
-        jti: jwtId,
-        iat: Math.floor(Date.now() / 1000),
-        ...options.payload,
-        ...additionalPayload
-      };
-      try {
-        const headerParams = {
-          alg: defaultAlgorithm,
-          typ: "JWT",
-          ...options.header ? Object.fromEntries(Object.entries(options.header).filter(([key]) => key !== "b64")) : {}
-        };
-        const jwt2 = new SignJWT(finalPayload).setProtectedHeader(headerParams).setIssuedAt().setExpirationTime(expiration);
-        if (finalPayload.iss)
-          jwt2.setIssuer(finalPayload.iss);
-        if (finalPayload.aud)
-          jwt2.setAudience(Array.isArray(finalPayload.aud) ? finalPayload.aud : [finalPayload.aud]);
-        return await jwt2.sign(encodedKey);
-      } catch (error) {
-        throw new HttpError({
-          message: JWT_ERROR_KEYS.JWT_SIGN_ERROR,
-          httpStatusCode: "INTERNAL_SERVER_ERROR",
-          cause: error
-        });
-      }
-    },
-    async verify(token) {
-      if (!token || token.trim() === "")
-        return false;
-      try {
-        const result = await jwtVerify(token, encodedKey, {
-          algorithms: [defaultAlgorithm]
-        });
-        return result;
-      } catch {
-        return false;
-      }
-    }
-  }).as("scoped");
-};
-export {
-  jwt
-};

package/dist/modules/elysia/jwt/jwt.d.ts

@@ -1,119 +0,0 @@
-import { Elysia } from 'elysia';
-import { type JWTPayload, type JWTVerifyResult } from 'jose';
-import type { JWTOptions } from './types/jwtOptions';
-/**
- * The `elysiaJwtPlugin` provides secure JSON Web Token (JWT) authentication capabilities for Elysia applications.
- *
- * This plugin leverages the industry-standard `jose` library to ensure robust JWT handling with modern cryptographic standards.
- *
- * @template TJWTKeyName - The name to use for JWT functionality in the Elysia context (defaults to 'jwt')
- * @param options - Configuration options for the JWT plugin
- *
- * @returns An Elysia plugin that adds JWT functionality to the application context
- *
- * @throws ({@link HttpError}) - When the secret key is missing or invalid
- *
- * @example
- * Basic usage
- * ```ts
- * const app = new Elysia()
- *   .use(jwt({
- *     secret: process.env.JWT_SECRET!,
- *     exp: '1h'
- *   }))
- *   .post('/login', ({ jwt }) => {
- *     return jwt.sign({ userId: 123, role: 'user' });
- *   })
- *   .get('/protected', async ({ jwt, headers }) => {
- *     const token = headers.authorization?.replace('Bearer ', '');
- *     const payload = await jwt.verify(token);
- *     if (!payload) throw new Error('Invalid token');
- *     return { user: payload };
- *   });
- * ```
- * @example
- * Custom context key name
- * ```ts
- * const app2 = new Elysia()
- *   .use(jwt({
- *     jwtKeyName: 'auth',
- *     secret: 'my-secret'
- *   }))
- *   .post('/login', ({ auth }) => auth.sign({ id: 1 }));
- * ```
- */
-export declare const jwt: <const TJWTKeyName extends string = "jwt">(options: JWTOptions<TJWTKeyName>) => Elysia<"", {
-    decorator: { [name in TJWTKeyName]: {
-        /**
-         * Signs a JWT with the provided payload and optional expiration time.
-         *
-         * @param additionalPayload - Custom payload data to include in the JWT
-         * @param expiration - Token expiration time (overrides default if provided)
-         *
-         * @returns A Promise that resolves to the signed JWT string
-         *
-         * @throws ({@link HttpError}) - When JWT signing fails due to invalid payload or configuration
-         *
-         * @example
-         * Sign with user data
-         * ```ts
-         * const token = await jwt.sign({ userId: 123, role: 'admin' });
-         * ```
-         * @example
-         * Sign with custom expiration
-         * ```ts
-         * const token = await jwt.sign({ userId: 123 }, '2h');
-         * ````
-         * @example
-         * Sign with Date expiration
-         * ```ts
-         * const token = await jwt.sign({ userId: 123 }, new Date('2024-12-31'));
-         * ```
-         */
-        sign(additionalPayload?: JWTPayload, expiration?: number | string | Date): Promise<string>;
-        /**
-         * Verifies and decodes a JWT token.
-         *
-         * @param token - The JWT string to verify and decode
-         *
-         * @returns A Promise that resolves to the decoded payload or false if invalid
-         *
-         * @example
-         * Verify token from Authorization header
-         * ```ts
-         * const token = headers.authorization?.replace('Bearer ', '');
-         * const payload = await jwt.verify(token);
-         *
-         * if (payload) {
-         *   console.log('User ID:', payload.userId);
-         *   console.log('Token expires:', new Date(payload.exp! * 1000));
-         * } else {
-         *   console.log('Invalid or expired token');
-         * }
-         * ```
-         */
-        verify(token?: string): Promise<JWTVerifyResult | false>;
-    }; } extends infer T ? { [K in keyof T]: T[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/modules/elysia/jwt/types/index.d.ts

@@ -1 +0,0 @@
-export type { JWTOptions } from './jwtOptions';

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

@@ -1,98 +0,0 @@
-import type { JWSHeaderParameters, JWTPayload } from 'jose';
-/**
- * Configuration options for the JWT plugin.
- *
- * @template TJWTKeyName - The name to be used for accessing the JWT functionality in the Elysia context
- *
- * @example
- * ```ts
- * 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<TJWTKeyName extends string = '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'
-    */
-    readonly jwtKeyName?: TJWTKeyName;
-    /**
-    * Secret key used to sign and verify JWTs.
-    *
-    * @example
-    * Using a string secret
-    * ```ts
-    * secret: 'your-very-secret-key'
-    *```
-    * @example
-    * Using an environment variable (recommended for production)
-    * ```ts
-    * secret: process.env.JWT_SECRET
-    * ```
-    */
-    readonly 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
-    * Set tokens to expire after 1 hour
-    * ```ts
-    * exp: '1h'
-    * ```
-    * @example
-    * Set tokens to expire at a specific date
-    * ```ts
-    * exp: new Date('2023-12-31')
-    * ```
-    * @example
-    * Set tokens to expire after 3600 seconds (1 hour)
-    * ```ts
-    * exp: 3600
-    * ```
-    */
-    readonly exp?: number | string | Date;
-    /**
-    * Default JWT header parameters to include in every JWT.
-    *
-    * This allows you to specify additional metadata about the token.
-    */
-    readonly 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
-    * ```ts
-    * payload: {
-    *   iss: 'my-api',           // Issuer
-    *   aud: 'my-frontend',      // Audience
-    * }
-    * ```
-    */
-    readonly payload?: JWTPayload;
-}

package/dist/modules/elysia/ratelimit/enums/index.d.ts

@@ -1 +0,0 @@
-export { RATELIMIT_ERROR_KEYS } from './ratelimitErrorKeys';

package/dist/modules/elysia/ratelimit/enums/index.js

@@ -1,7 +0,0 @@
-// @bun
-import {
-  RATELIMIT_ERROR_KEYS
-} from "../../../../chunk-twaga0fp.js";
-export {
-  RATELIMIT_ERROR_KEYS
-};

package/dist/modules/elysia/ratelimit/enums/ratelimitErrorKeys.d.ts

@@ -1,3 +0,0 @@
-export declare const RATELIMIT_ERROR_KEYS: {
-    readonly RATELIMIT_EXCEEDED: "elysia.ratelimit.error.exceeded";
-};

package/dist/modules/elysia/ratelimit/index.d.ts

@@ -1 +0,0 @@
-export { rateLimit } from './ratelimit';

package/dist/modules/elysia/ratelimit/index.js

@@ -1,52 +0,0 @@
-// @bun
-import {
-  RATELIMIT_ERROR_KEYS
-} from "../../../chunk-twaga0fp.js";
-import {
-  HttpError
-} from "../../../chunk-683sda6e.js";
-import"../../../chunk-9nw6qekv.js";
-import"../../../chunk-vknq69e0.js";
-
-// source/modules/elysia/ratelimit/ratelimit.ts
-import { Elysia } from "elysia";
-var rateLimit = ({ redis, limit, window }) => new Elysia({
-  name: "rateLimit",
-  seed: {
-    redis,
-    limit,
-    window
-  }
-}).onRequest(async ({ set, request, server }) => {
-  const ip = request.headers.get("x-forwarded-for") || request.headers.get("x-real-ip") || server?.requestIP(request)?.address || "127.0.0.1";
-  const key = `ratelimit:${ip}`;
-  const current = await redis.get(key);
-  const count = current ? parseInt(current) : 0;
-  if (count === 0)
-    await redis.setex(key, window, "1");
-  else
-    await redis.incr(key);
-  const newCount = await redis.get(key);
-  const currentCount = newCount ? parseInt(newCount) : 0;
-  if (currentCount > limit) {
-    set.status = 429;
-    throw new HttpError({
-      message: RATELIMIT_ERROR_KEYS.RATELIMIT_EXCEEDED,
-      httpStatusCode: "TOO_MANY_REQUESTS",
-      cause: {
-        limit,
-        window,
-        remaining: 0,
-        reset: await redis.ttl(key)
-      }
-    });
-  }
-  set.headers = {
-    "X-RateLimit-Limit": limit.toString(),
-    "X-RateLimit-Remaining": Math.max(0, limit - currentCount).toString(),
-    "X-RateLimit-Reset": (await redis.ttl(key)).toString()
-  };
-}).as("scoped");
-export {
-  rateLimit
-};