@flusys/nestjs-shared 0.1.0-beta.2 → 1.0.0-beta

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

@@ -72,22 +72,19 @@ let RequestMetaDto = class RequestMetaDto {
 };
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        example: 'req_abc123',
-        description: 'Unique request ID'
+        example: 'req_abc123'
     }),
     _ts_metadata("design:type", String)
 ], RequestMetaDto.prototype, "requestId", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        example: '2024-12-19T10:30:00.000Z',
-        description: 'Request timestamp'
+        example: '2024-12-19T10:30:00.000Z'
     }),
     _ts_metadata("design:type", String)
 ], RequestMetaDto.prototype, "timestamp", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        example: 45,
-        description: 'Response time in milliseconds'
+        example: 45
     }),
     _ts_metadata("design:type", Number)
 ], RequestMetaDto.prototype, "responseTime", void 0);
@@ -101,28 +98,23 @@ let SingleResponseDto = class SingleResponseDto {
 };
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: true,
-        description: 'Whether the operation was successful'
+        example: true
     }),
     _ts_metadata("design:type", Boolean)
 ], SingleResponseDto.prototype, "success", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: 'Operation successful',
-        description: 'Response message'
+        example: 'Operation successful'
     }),
     _ts_metadata("design:type", String)
 ], SingleResponseDto.prototype, "message", void 0);
 _ts_decorate([
-    (0, _swagger.ApiPropertyOptional)({
-        description: 'Response data (single item)'
-    }),
+    (0, _swagger.ApiPropertyOptional)(),
     _ts_metadata("design:type", typeof T === "undefined" ? Object : T)
 ], SingleResponseDto.prototype, "data", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        type: RequestMetaDto,
-        description: 'Request metadata'
+        type: RequestMetaDto
     }),
     _ts_metadata("design:type", typeof RequestMetaDto === "undefined" ? Object : RequestMetaDto)
 ], SingleResponseDto.prototype, "_meta", void 0);
@@ -141,43 +133,37 @@ let PaginationMetaDto = class PaginationMetaDto {
 };
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: 100,
-        description: 'Total records in database'
+        example: 100
     }),
     _ts_metadata("design:type", Number)
 ], PaginationMetaDto.prototype, "total", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: 0,
-        description: 'Current page number (0-based)'
+        example: 0
     }),
     _ts_metadata("design:type", Number)
 ], PaginationMetaDto.prototype, "page", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: 10,
-        description: 'Items per page'
+        example: 10
     }),
     _ts_metadata("design:type", Number)
 ], PaginationMetaDto.prototype, "pageSize", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: 10,
-        description: 'Number of items in current response'
+        example: 10
     }),
     _ts_metadata("design:type", Number)
 ], PaginationMetaDto.prototype, "count", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        example: true,
-        description: 'Whether there are more pages'
+        example: true
     }),
     _ts_metadata("design:type", Boolean)
 ], PaginationMetaDto.prototype, "hasMore", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        example: 10,
-        description: 'Total number of pages'
+        example: 10
     }),
     _ts_metadata("design:type", Number)
 ], PaginationMetaDto.prototype, "totalPages", void 0);
@@ -192,36 +178,31 @@ let ListResponseDto = class ListResponseDto {
 };
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: true,
-        description: 'Whether the operation was successful'
+        example: true
     }),
     _ts_metadata("design:type", Boolean)
 ], ListResponseDto.prototype, "success", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: 'Data retrieved successfully',
-        description: 'Response message'
+        example: 'Data retrieved successfully'
     }),
     _ts_metadata("design:type", String)
 ], ListResponseDto.prototype, "message", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        description: 'Response data (array of items)',
         isArray: true
     }),
     _ts_metadata("design:type", Array)
 ], ListResponseDto.prototype, "data", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        type: PaginationMetaDto,
-        description: 'Pagination metadata'
+        type: PaginationMetaDto
     }),
     _ts_metadata("design:type", typeof PaginationMetaDto === "undefined" ? Object : PaginationMetaDto)
 ], ListResponseDto.prototype, "meta", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        type: RequestMetaDto,
-        description: 'Request metadata'
+        type: RequestMetaDto
     }),
     _ts_metadata("design:type", typeof RequestMetaDto === "undefined" ? Object : RequestMetaDto)
 ], ListResponseDto.prototype, "_meta", void 0);
@@ -237,22 +218,19 @@ let BulkMetaDto = class BulkMetaDto {
 };
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: 5,
-        description: 'Number of items successfully processed'
+        example: 5
     }),
     _ts_metadata("design:type", Number)
 ], BulkMetaDto.prototype, "count", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        example: 0,
-        description: 'Number of items that failed'
+        example: 0
     }),
     _ts_metadata("design:type", Number)
 ], BulkMetaDto.prototype, "failed", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        example: 5,
-        description: 'Total items in request'
+        example: 5
     }),
     _ts_metadata("design:type", Number)
 ], BulkMetaDto.prototype, "total", void 0);
@@ -267,36 +245,31 @@ let BulkResponseDto = class BulkResponseDto {
 };
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: true,
-        description: 'Whether the operation was successful'
+        example: true
     }),
     _ts_metadata("design:type", Boolean)
 ], BulkResponseDto.prototype, "success", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: 'Items processed successfully',
-        description: 'Response message'
+        example: 'Items processed successfully'
     }),
     _ts_metadata("design:type", String)
 ], BulkResponseDto.prototype, "message", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        description: 'Response data (array of items)',
         isArray: true
     }),
     _ts_metadata("design:type", Array)
 ], BulkResponseDto.prototype, "data", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        type: BulkMetaDto,
-        description: 'Bulk operation metadata'
+        type: BulkMetaDto
     }),
     _ts_metadata("design:type", typeof BulkMetaDto === "undefined" ? Object : BulkMetaDto)
 ], BulkResponseDto.prototype, "meta", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        type: RequestMetaDto,
-        description: 'Request metadata'
+        type: RequestMetaDto
     }),
     _ts_metadata("design:type", typeof RequestMetaDto === "undefined" ? Object : RequestMetaDto)
 ], BulkResponseDto.prototype, "_meta", void 0);
@@ -312,22 +285,19 @@ let MessageResponseDto = class MessageResponseDto {
 };
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: true,
-        description: 'Whether the operation was successful'
+        example: true
     }),
     _ts_metadata("design:type", Boolean)
 ], MessageResponseDto.prototype, "success", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: 'Operation completed successfully',
-        description: 'Response message'
+        example: 'Operation completed successfully'
     }),
     _ts_metadata("design:type", String)
 ], MessageResponseDto.prototype, "message", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        type: RequestMetaDto,
-        description: 'Request metadata'
+        type: RequestMetaDto
     }),
     _ts_metadata("design:type", typeof RequestMetaDto === "undefined" ? Object : RequestMetaDto)
 ], MessageResponseDto.prototype, "_meta", void 0);
@@ -343,22 +313,19 @@ let ValidationErrorDto = class ValidationErrorDto {
 };
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: 'email',
-        description: 'Field that failed validation'
+        example: 'email'
     }),
     _ts_metadata("design:type", String)
 ], ValidationErrorDto.prototype, "field", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: 'Invalid email format',
-        description: 'Error message'
+        example: 'Invalid email format'
     }),
     _ts_metadata("design:type", String)
 ], ValidationErrorDto.prototype, "message", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        example: 'isEmail',
-        description: 'Validation constraint that failed'
+        example: 'isEmail'
     }),
     _ts_metadata("design:type", String)
 ], ValidationErrorDto.prototype, "constraint", void 0);
@@ -373,22 +340,19 @@ let ErrorResponseDto = class ErrorResponseDto {
 };
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: false,
-        description: 'Always false for errors'
+        example: false
     }),
     _ts_metadata("design:type", Boolean)
 ], ErrorResponseDto.prototype, "success", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: 'Validation failed',
-        description: 'Error message'
+        example: 'Validation failed'
     }),
     _ts_metadata("design:type", String)
 ], ErrorResponseDto.prototype, "message", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        example: 'VALIDATION_ERROR',
-        description: 'Error code'
+        example: 'VALIDATION_ERROR'
     }),
     _ts_metadata("design:type", String)
 ], ErrorResponseDto.prototype, "code", void 0);
@@ -396,15 +360,13 @@ _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
         type: [
             ValidationErrorDto
-        ],
-        description: 'Validation errors (for 400 responses)'
+        ]
     }),
     _ts_metadata("design:type", Array)
 ], ErrorResponseDto.prototype, "errors", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        type: RequestMetaDto,
-        description: 'Request metadata'
+        type: RequestMetaDto
     }),
     _ts_metadata("design:type", typeof RequestMetaDto === "undefined" ? Object : RequestMetaDto)
 ], ErrorResponseDto.prototype, "_meta", void 0);
@@ -422,34 +384,27 @@ let ResponsePayloadDto = class ResponsePayloadDto {
 };
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: true,
-        description: 'Whether the operation was successful'
+        example: true
     }),
     _ts_metadata("design:type", Boolean)
 ], ResponsePayloadDto.prototype, "success", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)({
-        example: 'Operation successful',
-        description: 'Response message'
+        example: 'Operation successful'
     }),
     _ts_metadata("design:type", String)
 ], ResponsePayloadDto.prototype, "message", void 0);
 _ts_decorate([
-    (0, _swagger.ApiPropertyOptional)({
-        description: 'Response data'
-    }),
+    (0, _swagger.ApiPropertyOptional)(),
     _ts_metadata("design:type", typeof T === "undefined" ? Object : T)
 ], ResponsePayloadDto.prototype, "data", void 0);
 _ts_decorate([
-    (0, _swagger.ApiPropertyOptional)({
-        description: 'Response metadata'
-    }),
+    (0, _swagger.ApiPropertyOptional)(),
     _ts_metadata("design:type", Object)
 ], ResponsePayloadDto.prototype, "meta", void 0);
 _ts_decorate([
     (0, _swagger.ApiPropertyOptional)({
-        type: RequestMetaDto,
-        description: 'Request metadata'
+        type: RequestMetaDto
     }),
     _ts_metadata("design:type", typeof RequestMetaDto === "undefined" ? Object : RequestMetaDto)
 ], ResponsePayloadDto.prototype, "_meta", void 0);

package/cjs/interfaces/logged-user-info.interface.js

@@ -1,6 +1,5 @@
 /**
- * Interface representing the logged-in user information
- * This is extracted from the JWT token payload
+ * Logged-in user information from JWT token payload
  */ "use strict";
 Object.defineProperty(exports, "__esModule", {
     value: true

package/cjs/interfaces/permission.interface.js

@@ -1,13 +1,4 @@
-/**
- * Permission-related interfaces and types
- */ // =============================================================================
-// PERMISSION OPERATORS
-// =============================================================================
-/**
- * Permission operator type
- * - 'and': User must have ALL permissions
- * - 'or': User must have at least ONE permission
- */ "use strict";
+"use strict";
 Object.defineProperty(exports, "__esModule", {
     value: true
 });

package/cjs/middlewares/logger.middleware.js

@@ -59,9 +59,7 @@ function _ts_decorate(decorators, target, key, desc) {
     else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
-// =============================================================================
-// CONFIGURATION
-// =============================================================================
+// Configuration
 const IS_DEBUG = _config.envConfig.getLogConfig().level === 'debug';
 const TENANT_ID_HEADER = 'x-tenant-id';
 const EXCLUDED_PATHS = [
@@ -88,9 +86,7 @@ const setCompanyId = (companyId)=>{
     const store = requestContext.getStore();
     if (store) store.companyId = companyId;
 };
-// =============================================================================
-// HELPER FUNCTIONS
-// =============================================================================
+// Helper Functions
 function sanitizeHeaders(headers) {
     const sanitized = {};
     for (const [key, value] of Object.entries(headers)){

package/cjs/modules/datasource/multi-tenant-datasource.service.js

@@ -42,7 +42,7 @@ function _ts_param(paramIndex, decorator) {
     };
 }
 let MultiTenantDataSourceService = class MultiTenantDataSourceService {
-    // ==================== Initialization ====================
+    // Initialization
     initializeFromOptions() {
         if (!this.options) return;
         if (!MultiTenantDataSourceService.initialized) {
@@ -55,7 +55,7 @@ let MultiTenantDataSourceService = class MultiTenantDataSourceService {
             MultiTenantDataSourceService.tenantsRegistry.set(tenant.id, tenant);
         });
     }
-    // ==================== Public API ====================
+    // Public API
     /**
    * Set custom tenant header name
    */ setTenantHeader(header) {
@@ -71,7 +71,7 @@ let MultiTenantDataSourceService = class MultiTenantDataSourceService {
    */ isMultiTenant() {
         return this.getDatabaseMode() === 'multi-tenant';
     }
-    // ==================== Tenant Resolution ====================
+    // Tenant Resolution
     /**
    * Get current tenant ID from request header
    * Validates tenant ID format for security (alphanumeric, hyphens, underscores only)
@@ -106,7 +106,7 @@ let MultiTenantDataSourceService = class MultiTenantDataSourceService {
    */ getActiveTenants() {
         return this.getAllTenants();
     }
-    // ==================== DataSource Access ====================
+    // DataSource Access
     /**
    * Get DataSource for current context (tenant or single)
    */ async getDataSource() {
@@ -126,7 +126,7 @@ let MultiTenantDataSourceService = class MultiTenantDataSourceService {
    */ setDataSource(dataSource) {
         MultiTenantDataSourceService.singleDataSource = dataSource;
     }
-    // ==================== Repository Access ====================
+    // Repository Access
     /**
    * Get repository for entity in current context
    */ async getRepository(entity) {
@@ -139,7 +139,7 @@ let MultiTenantDataSourceService = class MultiTenantDataSourceService {
         const dataSource = await this.getDataSourceForTenant(tenantId);
         return dataSource.getRepository(entity);
     }
-    // ==================== Multi-Tenant Operations ====================
+    // Multi-Tenant Operations
     /**
    * Execute callback with specific tenant's DataSource
    */ async withTenant(tenantId, callback) {
@@ -160,7 +160,7 @@ let MultiTenantDataSourceService = class MultiTenantDataSourceService {
         }
         return results;
     }
-    // ==================== Tenant Management ====================
+    // Tenant Management
     /**
    * Register a new tenant at runtime
    */ registerTenant(tenant) {
@@ -172,7 +172,7 @@ let MultiTenantDataSourceService = class MultiTenantDataSourceService {
         await this.closeTenantConnection(tenantId);
         MultiTenantDataSourceService.tenantsRegistry.delete(tenantId);
     }
-    // ==================== Connection Lifecycle ====================
+    // Connection Lifecycle
     /**
    * Close specific tenant connection
    */ async closeTenantConnection(tenantId) {
@@ -200,7 +200,7 @@ let MultiTenantDataSourceService = class MultiTenantDataSourceService {
         MultiTenantDataSourceService.tenantsRegistry.clear();
         MultiTenantDataSourceService.connectionLocks.clear();
     }
-    // ==================== Protected Methods (for subclasses) ====================
+    // Protected Methods (for subclasses)
     /**
    * Get single database DataSource with connection locking to prevent race conditions
    */ async getSingleDataSource() {

package/fesm/classes/api-controller.class.js

@@ -77,54 +77,7 @@ import { ApiResponseDto } from '../decorators/api-response.decorator';
     }
     return applyDecorators(...decorators);
 }
-// =============================================================================
-// API CONTROLLER FACTORY
-// =============================================================================
-/**
- * Creates an API Controller with standardized CRUD endpoints
- *
- * Features:
- * - POST-only API pattern (RPC-style)
- * - Configurable security per endpoint
- * - Consistent response format
- * - Idempotency support for inserts
- * - Pagination with metadata
- * - Bulk operations with counts
- * - Soft delete/restore/permanent delete
- *
- * @param createDtoClass - DTO for create operations
- * @param updateDtoClass - DTO for update operations
- * @param responseDtoClass - DTO for response serialization
- * @param options - Controller options including security configuration
- *
- * @example
- * // All public (default)
- * class ProductController extends createApiController(CreateDto, UpdateDto, ResponseDto) {}
- *
- * @example
- * // Option 1: Apply one security config to ALL endpoints
- * class ProductController extends createApiController(CreateDto, UpdateDto, ResponseDto, {
- *   security: 'jwt' // All endpoints require JWT
- * })
- *
- * @example
- * // Option 1: Global permission for all endpoints
- * class ProductController extends createApiController(CreateDto, UpdateDto, ResponseDto, {
- *   security: { level: 'permission', permissions: ['products.*'] }
- * })
- *
- * @example
- * // Option 2: Configure security per endpoint
- * class ProductController extends createApiController(CreateDto, UpdateDto, ResponseDto, {
- *   security: {
- *     getAll: 'public',
- *     getById: 'jwt',
- *     insert: { level: 'permission', permissions: ['products.create'] },
- *     update: { level: 'permission', permissions: ['products.update'] },
- *     delete: { level: 'permission', permissions: ['products.delete'] },
- *   }
- * }) {}
- */ export function createApiController(createDtoClass, updateDtoClass, responseDtoClass, options = {}) {
+/** Creates an API Controller with standardized CRUD endpoints (POST-only RPC pattern) */ export function createApiController(createDtoClass, updateDtoClass, responseDtoClass, options = {}) {
     // Determine if security is global (applies to all) or per-endpoint
     const securityConfig = options.security;
     const endpointKeys = [
@@ -154,9 +107,6 @@ import { ApiResponseDto } from '../decorators/api-response.decorator';
         delete: isGlobalSecurity ? defaultSecurity : normalizeSecurity(securityConfig?.delete)
     };
     let ApiController = class ApiController {
-        // =========================================================================
-        // INSERT (Single Item) - With Idempotency Support
-        // =========================================================================
         async insert(addDto, user) {
             const entity = await this.service.insert(addDto, user);
             const data = plainToInstance(responseDtoClass, entity);
@@ -166,9 +116,6 @@ import { ApiResponseDto } from '../decorators/api-response.decorator';
                 data
             };
         }
-        // =========================================================================
-        // INSERT MANY (Bulk) - With Idempotency Support
-        // =========================================================================
         async insertMany(addDto, user) {
             const entities = await this.service.insertMany(addDto, user);
             const data = entities.map((item)=>plainToInstance(responseDtoClass, item));
@@ -183,9 +130,6 @@ import { ApiResponseDto } from '../decorators/api-response.decorator';
                 }
             };
         }
-        // =========================================================================
-        // GET BY ID (Single Item)
-        // =========================================================================
         async getById(id, body, user) {
             const entity = await this.service.findById(id, user, body?.select);
             const data = plainToInstance(responseDtoClass, entity);
@@ -195,9 +139,6 @@ import { ApiResponseDto } from '../decorators/api-response.decorator';
                 data
             };
         }
-        // =========================================================================
-        // UPDATE (Single Item)
-        // =========================================================================
         async update(updateDto, user) {
             const entity = await this.service.update(updateDto, user);
             const data = plainToInstance(responseDtoClass, entity);
@@ -207,9 +148,6 @@ import { ApiResponseDto } from '../decorators/api-response.decorator';
                 data
             };
         }
-        // =========================================================================
-        // UPDATE MANY (Bulk)
-        // =========================================================================
         async updateMany(updateDtos, user) {
             const entities = await this.service.updateMany(updateDtos, user);
             const data = plainToInstance(responseDtoClass, entities);
@@ -224,9 +162,6 @@ import { ApiResponseDto } from '../decorators/api-response.decorator';
                 }
             };
         }
-        // =========================================================================
-        // GET ALL (Paginated List)
-        // =========================================================================
         async getAll(filterAndPaginationDto, user, search) {
             const result = await this.service.getAll(search ?? '', filterAndPaginationDto, user);
             const data = plainToInstance(responseDtoClass, result.data);
@@ -247,9 +182,6 @@ import { ApiResponseDto } from '../decorators/api-response.decorator';
                 }
             };
         }
-        // =========================================================================
-        // DELETE (Soft/Restore/Permanent)
-        // =========================================================================
         async delete(deleteDto, user) {
             await this.service.delete(deleteDto, user);
             const count = Array.isArray(deleteDto.id) ? deleteDto.id.length : 1;