mielk-api 1.5.3 → 1.5.5

package/dist/http/apiResponse/apiResponse.js

@@ -1,5 +1,6 @@
 import { isPrimitive } from 'mielk-fn/variables';
 import { HttpResponseStatus } from '../httpResponseStatus/HttpResponseStatus.js';
+import { isProd } from '../../routing/express.js';
 export function success(res, status, data) {
     const apiResponse = {
         success: true,
@@ -28,8 +29,7 @@ export function serverError(res, err) {
     const status = HttpResponseStatus.SERVER_ERROR;
     const apiError = {
         success: false,
-        message: `message: ${err.message} | stack: ${(_a = err.stack) === null || _a === void 0 ? void 0 : _a.toString()}`
-        // message: isProd() ? status.defaultMessageTag : `message: ${err.message} | stack: ${err.stack?.toString()}`,
+        message: isProd() ? status.defaultMessageTag : `message: ${err.message} | stack: ${(_a = err.stack) === null || _a === void 0 ? void 0 : _a.toString()}`,
     };
     return res.status(status.code).json(apiError);
 }

package/dist/middlewares/index.d.ts

@@ -3,18 +3,6 @@ import { privateCors } from './cors/privateCors.js';
 import { publicCors } from './cors/publicCors.js';
 import { apiKeyAuthorization } from './requestAuth/auth.middleware.js';
 import { validateQueryParams, validateBodyJson } from './zod/validate.js';
-import { RedisLockerConfigFactory } from './redis/redisLockerConfigFactory.js';
-import { RedisLockerConfig, RedisLockerConfigParams } from './redis/types.js';
-import { setRedisLock, removeRedisLock } from './redis/redisLocker.js';
-import { RedisLockCheckerConfigFactory } from './redis/redisLockCheckerConfigFactory.js';
-import { RedisLockChecker, RedisLockCheckerConfig, RedisLockCheckerConfigParams } from './redis/types.js';
-import { createRedisLockChecker, checkIfLockedInRedis } from './redis/redisLockChecker.js';
 export { CorsConfig, initCors, privateCors, publicCors };
 export { apiKeyAuthorization };
 export { validateQueryParams, validateBodyJson };
-export { RedisLockerConfigFactory };
-export { RedisLockerConfig, RedisLockerConfigParams };
-export { setRedisLock, removeRedisLock };
-export { createRedisLockChecker, checkIfLockedInRedis };
-export { RedisLockCheckerConfigFactory };
-export { RedisLockChecker, RedisLockCheckerConfig, RedisLockCheckerConfigParams };

package/dist/middlewares/index.js

@@ -3,18 +3,6 @@ import { privateCors } from './cors/privateCors.js';
 import { publicCors } from './cors/publicCors.js';
 import { apiKeyAuthorization } from './requestAuth/auth.middleware.js';
 import { validateQueryParams, validateBodyJson } from './zod/validate.js';
-// Redis locker
-import { RedisLockerConfigFactory } from './redis/redisLockerConfigFactory.js';
-import { setRedisLock, removeRedisLock } from './redis/redisLocker.js';
-// Redis lock checker
-import { RedisLockCheckerConfigFactory } from './redis/redisLockCheckerConfigFactory.js';
-import { createRedisLockChecker, checkIfLockedInRedis } from './redis/redisLockChecker.js';
 export { initCors, privateCors, publicCors };
 export { apiKeyAuthorization };
 export { validateQueryParams, validateBodyJson };
-// Redis locker
-export { RedisLockerConfigFactory };
-export { setRedisLock, removeRedisLock };
-// Redis lock checker
-export { createRedisLockChecker, checkIfLockedInRedis };
-export { RedisLockCheckerConfigFactory };

package/dist/middlewares/rateLimit/createRateLimiter.js

@@ -12,6 +12,7 @@ import { failure, HttpResponseStatus } from '../../http/index.js';
 import { RateLimitConfigFactory } from './rateLimitConfigFactory.js';
 import { generateRedisLockKey } from '../redis/redisLockChecker.js';
 import { Msg } from '../../internal/messaging/messageTags.js';
+import { generateRedisKey } from '../redis/redisKeysFactory.js';
 export const createGlobalRateLimiter = (config) => {
     return createRateLimiter(RateLimitConfigFactory.globalIp(config));
 };
@@ -32,8 +33,8 @@ export const createRateLimiter = (config) => {
     });
 };
 const createRateLimitFromConfig = (config, req) => {
-    const { limit, windowSec, message, redisLockerConfig } = config;
-    const key = generateKeyFromConfig(config, req);
+    const { keyPrefix, keySuffixes, limit, windowSec, message, redisLockerConfig } = config;
+    const key = generateRedisKey(keyPrefix, keySuffixes, req);
     const rateLimit = { key, limit, windowSec, message };
     if (redisLockerConfig) {
         const { keyPrefix, ttlSeconds } = redisLockerConfig;
@@ -44,7 +45,3 @@ const createRateLimitFromConfig = (config, req) => {
     }
     return rateLimit;
 };
-const generateKeyFromConfig = (config, req) => {
-    const { keyPrefix, keySuffixes } = config;
-    return `${keyPrefix}:${keySuffixes(req).join(':')}`;
-};

package/dist/middlewares/rateLimit/index.d.ts

@@ -1,8 +1,7 @@
 import { checkRateLimit } from './checkRateLimit.js';
 import { createRateLimiter } from './createRateLimiter.js';
 import { RateLimitConfigFactory } from './rateLimitConfigFactory.js';
-import { RedisKeyFactory } from '../redis/redisKeysFactory.js';
 import { type RateLimiter, RateLimitConfig, RateLimit, RateLimitCheck } from './types.js';
-export { checkRateLimit, createRateLimiter, RateLimitConfigFactory, RedisKeyFactory };
+export { checkRateLimit, createRateLimiter, RateLimitConfigFactory };
 export { RateLimitConfig, RateLimit, RateLimitCheck };
 export type { RateLimiter };

package/dist/middlewares/rateLimit/index.js

@@ -1,5 +1,4 @@
 import { checkRateLimit } from './checkRateLimit.js';
 import { createRateLimiter } from './createRateLimiter.js';
 import { RateLimitConfigFactory } from './rateLimitConfigFactory.js';
-import { RedisKeyFactory } from '../redis/redisKeysFactory.js';
-export { checkRateLimit, createRateLimiter, RateLimitConfigFactory, RedisKeyFactory };
+export { checkRateLimit, createRateLimiter, RateLimitConfigFactory };

package/dist/middlewares/rateLimit/rateLimitConfigFactory.js

@@ -1,7 +1,7 @@
 import { RedisKeyFactory } from "../redis/redisKeysFactory.js";
 import { Msg } from "../../internal/messaging/messageTags.js";
 const defaultRateLimitConfig = {
-    keyPrefix: RedisKeyFactory.prefixes.login,
+    keyPrefix: RedisKeyFactory.prefixes.authLogin,
     keySuffixes: RedisKeyFactory.suffixes.ip,
     windowSec: 15 * 60,
     limit: 5,
@@ -11,7 +11,7 @@ const createRateLimitConfig = (params) => {
     return Object.assign(Object.assign({}, defaultRateLimitConfig), params);
 };
 const globalIp = (params) => {
-    return createRateLimitConfig(Object.assign({ keyPrefix: RedisKeyFactory.prefixes.global, windowSec: 60, limit: 2 }, (params || {})));
+    return createRateLimitConfig(Object.assign({ keyPrefix: RedisKeyFactory.prefixes.authGlobal, windowSec: 60, limit: 2 }, (params || {})));
 };
 const loginIp = (params) => {
     return createRateLimitConfig(Object.assign({}, (params || {})));
@@ -20,7 +20,7 @@ const loginIpMail = (params) => {
     return createRateLimitConfig(Object.assign({ keySuffixes: RedisKeyFactory.suffixes.ipMail }, (params || {})));
 };
 const loginMail = (params) => {
-    return createRateLimitConfig(Object.assign({ keySuffixes: RedisKeyFactory.suffixes.mail, redisLockerConfig: { keyPrefix: RedisKeyFactory.prefixes.lockEmail, ttlSeconds: 15 * 60 } }, (params || {})));
+    return createRateLimitConfig(Object.assign({ keySuffixes: RedisKeyFactory.suffixes.mail, redisLockerConfig: { keyPrefix: RedisKeyFactory.prefixes.authLockEmail, ttlSeconds: 15 * 60 } }, (params || {})));
 };
 export const RateLimitConfigFactory = {
     globalIp,

package/dist/middlewares/redis/index.d.ts

@@ -0,0 +1,14 @@
+import { RedisLockerConfigFactory } from './redisLockerConfigFactory.js';
+import { RedisLockerConfig, RedisLockerConfigParams } from './types.js';
+import { setRedisLock, removeRedisLock } from './redisLocker.js';
+import { RedisLockCheckerConfigFactory } from './redisLockCheckerConfigFactory.js';
+import { RedisLockChecker, RedisLockCheckerConfig, RedisLockCheckerConfigParams } from './types.js';
+import { createRedisLockChecker, checkIfLockedInRedis } from './redisLockChecker.js';
+import { generateRedisKey, RedisKeyFactory } from './redisKeysFactory.js';
+export { RedisLockerConfigFactory };
+export { RedisLockerConfig, RedisLockerConfigParams };
+export { setRedisLock, removeRedisLock };
+export { createRedisLockChecker, checkIfLockedInRedis };
+export { RedisLockCheckerConfigFactory };
+export { RedisLockChecker, RedisLockCheckerConfig, RedisLockCheckerConfigParams };
+export { generateRedisKey, RedisKeyFactory };

package/dist/middlewares/redis/index.js

@@ -0,0 +1,16 @@
+// Redis locker
+import { RedisLockerConfigFactory } from './redisLockerConfigFactory.js';
+import { setRedisLock, removeRedisLock } from './redisLocker.js';
+// Redis lock checker
+import { RedisLockCheckerConfigFactory } from './redisLockCheckerConfigFactory.js';
+import { createRedisLockChecker, checkIfLockedInRedis } from './redisLockChecker.js';
+// Redis keys
+import { generateRedisKey, RedisKeyFactory } from './redisKeysFactory.js';
+// Redis locker
+export { RedisLockerConfigFactory };
+export { setRedisLock, removeRedisLock };
+// Redis lock checker
+export { createRedisLockChecker, checkIfLockedInRedis };
+export { RedisLockCheckerConfigFactory };
+// Redis keys
+export { generateRedisKey, RedisKeyFactory };

package/dist/middlewares/redis/redisKeysFactory.d.ts

@@ -1,10 +1,10 @@
 import { Request } from 'express';
 export declare const RedisKeyFactory: {
     prefixes: {
-        readonly global: "global";
-        readonly login: "login";
-        readonly lockEmail: "lock:email";
-        readonly refresh: "refresh";
+        readonly authGlobal: "auth.global";
+        readonly authLogin: "auth.login";
+        readonly authLockEmail: "auth.lock:email";
+        readonly authRefresh: "auth.refresh";
     };
     suffixes: {
         readonly ip: (req: Request) => string[];
@@ -12,3 +12,4 @@ export declare const RedisKeyFactory: {
         readonly mail: (req: Request) => string[];
     };
 };
+export declare const generateRedisKey: (prefix: string, suffixCallback: (req: Request) => string[], req: Request) => string;

package/dist/middlewares/redis/redisKeysFactory.js

@@ -1,8 +1,8 @@
 const prefixes = {
-    global: 'global',
-    login: 'login',
-    lockEmail: 'lock:email',
-    refresh: 'refresh',
+    authGlobal: 'auth.global',
+    authLogin: 'auth.login',
+    authLockEmail: 'auth.lock:email',
+    authRefresh: 'auth.refresh',
 };
 const getIpSuffixCallback = (req) => {
     const ip = req.ip || 'undefined';
@@ -28,3 +28,6 @@ export const RedisKeyFactory = {
     prefixes: prefixes,
     suffixes: suffixCallbacks
 };
+export const generateRedisKey = (prefix, suffixCallback, req) => {
+    return `${prefix}:${suffixCallback(req).join(':')}`;
+};

package/dist/middlewares/redis/redisLockCheckerConfigFactory.js

@@ -1,7 +1,7 @@
 import { RedisKeyFactory } from "./redisKeysFactory.js";
 import { Msg } from "../../internal/messaging/messageTags.js";
 const defaultRedisLockCheckerConfig = {
-    keyPrefix: RedisKeyFactory.prefixes.lockEmail,
+    keyPrefix: RedisKeyFactory.prefixes.authLockEmail,
     keySuffixes: RedisKeyFactory.suffixes.mail,
     message: Msg.apiStatus.locked,
 };

package/dist/middlewares/redis/redisLockerConfigFactory.js

@@ -1,6 +1,6 @@
 import { RedisKeyFactory } from "./redisKeysFactory.js";
 const defaultRedisLockerConfig = {
-    keyPrefix: RedisKeyFactory.prefixes.lockEmail,
+    keyPrefix: RedisKeyFactory.prefixes.authLockEmail,
     ttlSeconds: 30 * 60,
 };
 const createRedisLockerConfig = (params) => {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "mielk-api",
-	"version": "1.5.3",
+	"version": "1.5.5",
 	"keywords": [],
 	"author": "mielk",
 	"description": "Wrapper for API operations",
@@ -37,6 +37,11 @@
 			"types": "./dist/middlewares/rateLimit/index.d.ts",
 			"import": "./dist/middlewares/rateLimit/index.js",
 			"default": "./dist/middlewares/rateLimit/index.js"
+		},
+		"./redis": {
+			"types": "./dist/middlewares/redis/index.d.ts",
+			"import": "./dist/middlewares/redis/index.js",
+			"default": "./dist/middlewares/redis/index.js"
 		}
 	},
 	"scripts": {