@flusys/nestjs-shared 3.0.1 → 4.0.0-lts

package/fesm/constants/message-keys.js

@@ -0,0 +1,59 @@
+// ==================== SHARED/SYSTEM MESSAGE KEYS ====================
+// Package-specific messages are now in their respective packages:
+// - nestjs-auth/src/config/message-keys.ts
+// - nestjs-iam/src/config/message-keys.ts
+// - nestjs-storage/src/config/message-keys.ts
+// - nestjs-email/src/config/message-keys.ts
+// - nestjs-form-builder/src/config/message-keys.ts
+// - nestjs-event-manager/src/config/message-keys.ts
+// - nestjs-notification/src/config/message-keys.ts
+// - nestjs-localization/src/config/message-keys.ts
+// ==================== AUTH (Shared across guards/interceptors) ====================
+// These are duplicated in nestjs-auth but needed here to avoid circular dependencies
+export const AUTH_MESSAGES = {
+    TOKEN_REQUIRED: 'auth.token.required',
+    TOKEN_INVALID: 'auth.token.invalid',
+    TOKEN_EXPIRED: 'auth.token.expired',
+    COMPANY_NO_ACCESS: 'auth.company.no.access'
+};
+// ==================== ERROR (HTTP Exceptions) ====================
+export const ERROR_MESSAGES = {
+    NOT_FOUND: 'error.not.found',
+    VALIDATION: 'error.validation',
+    UNAUTHORIZED: 'error.unauthorized',
+    FORBIDDEN: 'error.forbidden',
+    CONFLICT: 'error.conflict',
+    INTERNAL: 'error.internal',
+    SERVICE_UNAVAILABLE: 'error.service.unavailable',
+    UNKNOWN: 'error.unknown',
+    HTTP: 'error.http',
+    GENERIC: 'error.generic',
+    PERMISSION_SYSTEM_UNAVAILABLE: 'error.permission.system.unavailable',
+    INSUFFICIENT_PERMISSIONS: 'error.insufficient.permissions',
+    INSUFFICIENT_PERMISSIONS_OR: 'error.insufficient.permissions.or',
+    NO_PERMISSIONS_FOUND: 'error.no.permissions.found'
+};
+// ==================== SYSTEM (Infrastructure) ====================
+export const SYSTEM_MESSAGES = {
+    REPOSITORY_NOT_AVAILABLE: 'system.repository.not.available',
+    DATASOURCE_NOT_AVAILABLE: 'system.datasource.not.available',
+    DATABASE_CONFIG_NOT_AVAILABLE: 'system.database.config.not.available',
+    SERVICE_NOT_AVAILABLE: 'system.service.not.available',
+    CONFIG_REQUIRED: 'system.config.required',
+    INTERNAL_ERROR: 'system.internal.error',
+    NOT_FOUND: 'system.not.found',
+    DUPLICATE_REQUEST: 'system.duplicate.request',
+    INVALID_TENANT_ID: 'system.invalid.tenant.id',
+    TENANT_NOT_FOUND: 'system.tenant.not.found',
+    TENANT_HEADER_REQUIRED: 'system.tenant.header.required',
+    MISSING_PARAMETER: 'system.missing.parameter',
+    SDK_NOT_INSTALLED: 'system.sdk.not.installed',
+    PATH_TRAVERSAL_DETECTED: 'system.path.traversal.detected',
+    INVALID_FILE_KEY: 'system.invalid.file.key'
+};
+// ==================== AGGREGATED EXPORTS ====================
+export const MESSAGE_KEYS = {
+    AUTH: AUTH_MESSAGES,
+    ERROR: ERROR_MESSAGES,
+    SYSTEM: SYSTEM_MESSAGES
+};

package/fesm/constants/permissions.js

@@ -111,6 +111,25 @@ export const NOTIFICATION_PERMISSIONS = {
     UPDATE: 'notification.update',
     DELETE: 'notification.delete'
 };
+// ==================== LOCALIZATION MODULE ====================
+export const LANGUAGE_PERMISSIONS = {
+    CREATE: 'language.create',
+    READ: 'language.read',
+    UPDATE: 'language.update',
+    DELETE: 'language.delete'
+};
+export const TRANSLATION_KEY_PERMISSIONS = {
+    CREATE: 'translation-key.create',
+    READ: 'translation-key.read',
+    UPDATE: 'translation-key.update',
+    DELETE: 'translation-key.delete'
+};
+export const TRANSLATION_PERMISSIONS = {
+    CREATE: 'translation.create',
+    READ: 'translation.read',
+    UPDATE: 'translation.update',
+    DELETE: 'translation.delete'
+};
 // ==================== AGGREGATED EXPORTS ====================
 export const PERMISSIONS = {
     // Auth
@@ -138,5 +157,9 @@ export const PERMISSIONS = {
     EVENT: EVENT_PERMISSIONS,
     EVENT_PARTICIPANT: EVENT_PARTICIPANT_PERMISSIONS,
     // Notification
-    NOTIFICATION: NOTIFICATION_PERMISSIONS
+    NOTIFICATION: NOTIFICATION_PERMISSIONS,
+    // Localization
+    LANGUAGE: LANGUAGE_PERMISSIONS,
+    TRANSLATION_KEY: TRANSLATION_KEY_PERMISSIONS,
+    TRANSLATION: TRANSLATION_PERMISSIONS
 };

package/fesm/decorators/index.js

@@ -1,5 +1,6 @@
 export * from './api-response.decorator';
 export * from './current-user.decorator';
+export * from './log-action.decorator';
 export * from './public.decorator';
 export * from './require-permission.decorator';
 export * from './sanitize-html.decorator';

package/fesm/decorators/log-action.decorator.js

@@ -0,0 +1,139 @@
+import { Logger } from '@nestjs/common';
+import { createModuleLogger } from '../classes/winston.logger.class';
+import { getRequestId, getUserId, getTenantId, getCompanyId } from '../middlewares/logger.middleware';
+function createLoggerAdapter(className, moduleName) {
+    if (moduleName) {
+        const winstonLogger = createModuleLogger(moduleName);
+        return {
+            log: (level, message, meta)=>{
+                winstonLogger.log(level, message, {
+                    context: className,
+                    ...meta
+                });
+            },
+            error: (message, stack, meta)=>{
+                winstonLogger.error(message, {
+                    context: className,
+                    stack,
+                    ...meta
+                });
+            }
+        };
+    }
+    const nestLogger = new Logger(className);
+    return {
+        log: (level, message, meta)=>{
+            nestLogger[level](message, meta);
+        },
+        error: (message, stack, meta)=>{
+            nestLogger.error(message, stack, meta);
+        }
+    };
+}
+export function LogAction(options = {}) {
+    return function(target, propertyKey, descriptor) {
+        const originalMethod = descriptor.value;
+        const className = target.constructor.name;
+        const methodName = String(propertyKey);
+        descriptor.value = async function(...args) {
+            const startTime = Date.now();
+            // Resolve module: decorator option > instance property > undefined
+            const moduleName = options.module || this.moduleName;
+            const logger = createLoggerAdapter(className, moduleName);
+            const action = options.action || `${this.entityName || className}.${methodName}`;
+            const logLevel = options.logLevel || 'debug';
+            const context = {
+                requestId: getRequestId(),
+                userId: getUserId(),
+                tenantId: getTenantId(),
+                companyId: getCompanyId(),
+                method: methodName,
+                module: moduleName
+            };
+            const startMessage = `Executing action method "${action}"`;
+            const startContext = options.includeParams ? {
+                ...context,
+                params: sanitizeParams(args)
+            } : context;
+            logger.log(logLevel, startMessage, startContext);
+            try {
+                const result = await originalMethod.apply(this, args);
+                const duration = Date.now() - startTime;
+                const resultType = getResultType(result);
+                const successMessage = `Executed action method "${action}", returned result "${resultType}" in ${duration.toFixed(2)}ms.`;
+                const successContext = options.includeResult && result ? {
+                    ...context,
+                    duration: `${duration}ms`,
+                    resultType,
+                    resultPreview: getResultPreview(result)
+                } : {
+                    ...context,
+                    duration: `${duration}ms`,
+                    resultType
+                };
+                logger.log(logLevel, successMessage, successContext);
+                return result;
+            } catch (error) {
+                const duration = Date.now() - startTime;
+                const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+                logger.error(`Failed action method "${action}" after ${duration.toFixed(2)}ms: ${errorMessage}`, error instanceof Error ? error.stack : undefined, {
+                    ...context,
+                    duration: `${duration}ms`,
+                    error: errorMessage
+                });
+                throw error;
+            }
+        };
+        return descriptor;
+    };
+}
+function sanitizeParams(args) {
+    return args.map((arg)=>{
+        if (arg === null || arg === undefined) return arg;
+        if (typeof arg === 'object') {
+            const sanitized = {
+                ...arg
+            };
+            const sensitiveKeys = [
+                'password',
+                'secret',
+                'token',
+                'apiKey',
+                'authorization'
+            ];
+            for (const key of Object.keys(sanitized)){
+                if (sensitiveKeys.some((sk)=>key.toLowerCase().includes(sk))) {
+                    sanitized[key] = '[REDACTED]';
+                }
+            }
+            return sanitized;
+        }
+        return arg;
+    });
+}
+function getResultType(result) {
+    if (result === null) return 'null';
+    if (result === undefined) return 'undefined';
+    if (Array.isArray(result)) return `Array<${result.length} items>`;
+    if (typeof result === 'object') {
+        const name = result.constructor?.name;
+        return name && name !== 'Object' ? name : 'Object';
+    }
+    return typeof result;
+}
+function getResultPreview(result) {
+    if (Array.isArray(result)) {
+        return {
+            count: result.length,
+            sample: result.slice(0, 2)
+        };
+    }
+    if (typeof result === 'object' && result !== null) {
+        const keys = Object.keys(result).slice(0, 5);
+        return {
+            keys,
+            hasMore: Object.keys(result).length > 5
+        };
+    }
+    return result;
+}

package/fesm/dtos/response-payload.dto.js

@@ -50,6 +50,8 @@ export class SingleResponseDto {
     constructor(){
         _define_property(this, "success", void 0);
         _define_property(this, "message", void 0);
+        _define_property(this, "messageKey", void 0);
+        _define_property(this, "messageVariables", void 0);
         _define_property(this, "data", void 0);
         _define_property(this, "_meta", void 0);
     }
@@ -66,6 +68,22 @@ _ts_decorate([
     }),
     _ts_metadata("design:type", String)
 ], SingleResponseDto.prototype, "message", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'user.create.success',
+        description: 'Translation key for localization'
+    }),
+    _ts_metadata("design:type", String)
+], SingleResponseDto.prototype, "messageKey", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: {
+            name: 'John'
+        },
+        description: 'Variables for message interpolation'
+    }),
+    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
+], SingleResponseDto.prototype, "messageVariables", void 0);
 _ts_decorate([
     ApiPropertyOptional(),
     _ts_metadata("design:type", typeof T === "undefined" ? Object : T)
@@ -129,6 +147,8 @@ export class ListResponseDto {
     constructor(){
         _define_property(this, "success", void 0);
         _define_property(this, "message", void 0);
+        _define_property(this, "messageKey", void 0);
+        _define_property(this, "messageVariables", void 0);
         _define_property(this, "data", void 0);
         _define_property(this, "meta", void 0);
         _define_property(this, "_meta", void 0);
@@ -146,6 +166,22 @@ _ts_decorate([
     }),
     _ts_metadata("design:type", String)
 ], ListResponseDto.prototype, "message", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'user.list.success',
+        description: 'Translation key for localization'
+    }),
+    _ts_metadata("design:type", String)
+], ListResponseDto.prototype, "messageKey", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: {
+            count: 10
+        },
+        description: 'Variables for message interpolation'
+    }),
+    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
+], ListResponseDto.prototype, "messageVariables", void 0);
 _ts_decorate([
     ApiPropertyOptional({
         isArray: true
@@ -196,6 +232,8 @@ export class BulkResponseDto {
     constructor(){
         _define_property(this, "success", void 0);
         _define_property(this, "message", void 0);
+        _define_property(this, "messageKey", void 0);
+        _define_property(this, "messageVariables", void 0);
         _define_property(this, "data", void 0);
         _define_property(this, "meta", void 0);
         _define_property(this, "_meta", void 0);
@@ -213,6 +251,22 @@ _ts_decorate([
     }),
     _ts_metadata("design:type", String)
 ], BulkResponseDto.prototype, "message", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'user.bulk.success',
+        description: 'Translation key for localization'
+    }),
+    _ts_metadata("design:type", String)
+], BulkResponseDto.prototype, "messageKey", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: {
+            count: 5
+        },
+        description: 'Variables for message interpolation'
+    }),
+    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
+], BulkResponseDto.prototype, "messageVariables", void 0);
 _ts_decorate([
     ApiPropertyOptional({
         isArray: true
@@ -238,6 +292,8 @@ export class MessageResponseDto {
     constructor(){
         _define_property(this, "success", void 0);
         _define_property(this, "message", void 0);
+        _define_property(this, "messageKey", void 0);
+        _define_property(this, "messageVariables", void 0);
         _define_property(this, "_meta", void 0);
     }
 }
@@ -253,6 +309,22 @@ _ts_decorate([
     }),
     _ts_metadata("design:type", String)
 ], MessageResponseDto.prototype, "message", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 'user.delete.success',
+        description: 'Translation key for localization'
+    }),
+    _ts_metadata("design:type", String)
+], MessageResponseDto.prototype, "messageKey", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: {
+            count: 3
+        },
+        description: 'Variables for message interpolation'
+    }),
+    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
+], MessageResponseDto.prototype, "messageVariables", void 0);
 _ts_decorate([
     ApiPropertyOptional({
         type: RequestMetaDto

package/fesm/exceptions/base-app.exception.js

@@ -0,0 +1,109 @@
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+import { HttpException, HttpStatus } from '@nestjs/common';
+import { ERROR_MESSAGES } from '../constants/message-keys';
+export class BaseAppException extends HttpException {
+    constructor(options){
+        const status = options.status || HttpStatus.BAD_REQUEST;
+        super({
+            success: false,
+            message: options.message,
+            messageKey: options.messageKey || ERROR_MESSAGES.GENERIC,
+            messageParams: options.messageParams,
+            errors: options.errors
+        }, status), _define_property(this, "messageKey", void 0), _define_property(this, "messageParams", void 0), _define_property(this, "errors", void 0), _define_property(this, "metadata", void 0);
+        this.messageKey = options.messageKey || ERROR_MESSAGES.GENERIC;
+        this.messageParams = options.messageParams;
+        this.errors = options.errors;
+        this.metadata = options.metadata;
+    }
+}
+export class NotFoundException extends BaseAppException {
+    constructor(entity, id){
+        super({
+            message: id ? `${entity} with id "${id}" not found` : `${entity} not found`,
+            messageKey: ERROR_MESSAGES.NOT_FOUND,
+            status: HttpStatus.NOT_FOUND,
+            metadata: {
+                entity,
+                id
+            }
+        });
+    }
+}
+export class ValidationException extends BaseAppException {
+    constructor(errors){
+        super({
+            message: 'Validation failed',
+            messageKey: ERROR_MESSAGES.VALIDATION,
+            status: HttpStatus.BAD_REQUEST,
+            errors
+        });
+    }
+}
+export class UnauthorizedException extends BaseAppException {
+    constructor(message = 'Unauthorized access'){
+        super({
+            message,
+            messageKey: ERROR_MESSAGES.UNAUTHORIZED,
+            status: HttpStatus.UNAUTHORIZED
+        });
+    }
+}
+export class ForbiddenException extends BaseAppException {
+    constructor(message = 'Access forbidden'){
+        super({
+            message,
+            messageKey: ERROR_MESSAGES.FORBIDDEN,
+            status: HttpStatus.FORBIDDEN
+        });
+    }
+}
+export class ConflictException extends BaseAppException {
+    constructor(entity, field){
+        super({
+            message: field ? `${entity} with this ${field} already exists` : `${entity} already exists`,
+            messageKey: ERROR_MESSAGES.CONFLICT,
+            status: HttpStatus.CONFLICT,
+            metadata: {
+                entity,
+                field
+            }
+        });
+    }
+}
+export class InternalServerException extends BaseAppException {
+    constructor(message = 'Internal server error'){
+        super({
+            message,
+            messageKey: ERROR_MESSAGES.INTERNAL,
+            status: HttpStatus.INTERNAL_SERVER_ERROR
+        });
+    }
+}
+export class ServiceUnavailableException extends BaseAppException {
+    constructor(service){
+        super({
+            message: `${service} is temporarily unavailable`,
+            messageKey: ERROR_MESSAGES.SERVICE_UNAVAILABLE,
+            messageParams: {
+                service
+            },
+            status: HttpStatus.SERVICE_UNAVAILABLE,
+            metadata: {
+                service
+            }
+        });
+    }
+}

package/fesm/exceptions/index.js

@@ -1 +1,2 @@
+export * from './base-app.exception';
 export * from './permission.exception';

package/fesm/exceptions/permission.exception.js

@@ -1,37 +1,35 @@
 import { ForbiddenException, InternalServerErrorException } from '@nestjs/common';
-/**
- * Exception thrown when permission system is unavailable
- */ export class PermissionSystemUnavailableException extends InternalServerErrorException {
-    constructor(message = 'Permission system temporarily unavailable. Please try again later.'){
+import { ERROR_MESSAGES } from '../constants/message-keys';
+export class PermissionSystemUnavailableException extends InternalServerErrorException {
+    constructor(){
         super({
             success: false,
-            message,
-            code: 'PERMISSION_SYSTEM_UNAVAILABLE'
+            message: 'Permission system temporarily unavailable',
+            messageKey: ERROR_MESSAGES.PERMISSION_SYSTEM_UNAVAILABLE
         });
     }
 }
-/**
- * Exception thrown when user lacks required permissions
- */ export class InsufficientPermissionsException extends ForbiddenException {
+export class InsufficientPermissionsException extends ForbiddenException {
     constructor(missingPermissions, operator = 'AND'){
-        const message = operator === 'OR' ? `Requires at least one of: ${missingPermissions.join(', ')}` : `Missing required permissions: ${missingPermissions.join(', ')}`;
+        const messageKey = operator === 'OR' ? ERROR_MESSAGES.INSUFFICIENT_PERMISSIONS_OR : ERROR_MESSAGES.INSUFFICIENT_PERMISSIONS;
         super({
             success: false,
-            message,
-            code: 'INSUFFICIENT_PERMISSIONS',
+            message: 'Insufficient permissions',
+            messageKey,
+            messageParams: {
+                permissions: missingPermissions.join(', ')
+            },
             missingPermissions,
             operator
         });
     }
 }
-/**
- * Exception thrown when no permissions found for user
- */ export class NoPermissionsFoundException extends ForbiddenException {
+export class NoPermissionsFoundException extends ForbiddenException {
     constructor(){
         super({
             success: false,
-            message: 'No permissions found. Please contact administrator.',
-            code: 'NO_PERMISSIONS_FOUND'
+            message: 'No permissions found',
+            messageKey: ERROR_MESSAGES.NO_PERMISSIONS_FOUND
         });
     }
 }