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

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

@@ -14,14 +14,7 @@ function _define_property(obj, key, value) {
 import { ErrorHandler } from '../utils/error-handler.util';
 import { Logger, NotFoundException } from '@nestjs/common';
 import { In } from 'typeorm';
-/**
- * Generic API service to handle common CRUD operations with caching support.
- * This class is fully abstract and should be extended by concrete services
- * for specific entities.
- */ export class ApiService {
-    // ---------------------------------------------------------------------
-    // INSERT SINGLE ENTITY
-    // ---------------------------------------------------------------------
+/** Generic API service with CRUD operations and caching support */ export class ApiService {
     async insert(dto, user) {
         await this.ensureRepositoryInitialized();
         const qr = this.repository.manager.connection.createQueryRunner();
@@ -48,9 +41,6 @@ import { In } from 'typeorm';
             await qr.release();
         }
     }
-    // ---------------------------------------------------------------------
-    // INSERT MULTIPLE ENTITIES
-    // ---------------------------------------------------------------------
     async insertMany(dtos, user) {
         await this.ensureRepositoryInitialized();
         const qr = this.repository.manager.connection.createQueryRunner();
@@ -81,9 +71,6 @@ import { In } from 'typeorm';
             await qr.release();
         }
     }
-    // ---------------------------------------------------------------------
-    // UPDATE SINGLE ENTITY
-    // ---------------------------------------------------------------------
     async update(dto, user) {
         await this.ensureRepositoryInitialized();
         const qr = this.repository.manager.connection.createQueryRunner();
@@ -110,9 +97,6 @@ import { In } from 'typeorm';
             await qr.release();
         }
     }
-    // ---------------------------------------------------------------------
-    // UPDATE MULTIPLE ENTITIES
-    // ---------------------------------------------------------------------
     async updateMany(dtos, user) {
         await this.ensureRepositoryInitialized();
         const qr = this.repository.manager.connection.createQueryRunner();
@@ -143,9 +127,6 @@ import { In } from 'typeorm';
             await qr.release();
         }
     }
-    // ---------------------------------------------------------------------
-    // FIND BY IDS
-    // ---------------------------------------------------------------------
     async findByIds(ids, user) {
         await this.ensureRepositoryInitialized();
         try {
@@ -170,9 +151,6 @@ import { In } from 'typeorm';
             this.handleError(error, 'findByIds');
         }
     }
-    // ---------------------------------------------------------------------
-    // FIND BY ID
-    // ---------------------------------------------------------------------
     async findById(id, user, select) {
         await this.ensureRepositoryInitialized();
         try {
@@ -211,9 +189,6 @@ import { In } from 'typeorm';
             this.handleError(error, 'findById');
         }
     }
-    // ---------------------------------------------------------------------
-    // GET ALL (WITH FILTER, SORT, SEARCH, PAGINATION & CACHING)
-    // ---------------------------------------------------------------------
     async getAll(search, filterAndPaginationDto, user) {
         await this.ensureRepositoryInitialized();
         try {
@@ -312,9 +287,6 @@ import { In } from 'typeorm';
             this.handleError(error, 'getAll');
         }
     }
-    // ---------------------------------------------------------------------
-    // DELETE / RESTORE / HARD DELETE
-    // ---------------------------------------------------------------------
     async delete(option, user) {
         await this.ensureRepositoryInitialized();
         const queryRunner = this.repository.manager.connection.createQueryRunner();
@@ -357,9 +329,7 @@ import { In } from 'typeorm';
             await queryRunner.release();
         }
     }
-    // ---------------------------------------------------------------------
-    // CACHING HELPERS
-    // ---------------------------------------------------------------------
+    // Caching
     async clearCacheForAll() {
         await this.utilsService.clearCache(this.entityName, this.cacheManager);
     }
@@ -374,17 +344,8 @@ import { In } from 'typeorm';
         });
         ErrorHandler.rethrowError(error);
     }
-    // ---------------------------------------------------------------------
-    // HOOKS / HELPERS (OVERRIDE IN CHILD CLASSES)
-    // ---------------------------------------------------------------------
-    /**
-   * Hook called before ANY repository access
-   * CRITICAL: Override this in REQUEST-scoped services that use lazy repository initialization
-   * Example use case: DataSource Provider pattern where repository is set dynamically
-   */ async ensureRepositoryInitialized() {
-    // Default: no-op - repository is already initialized in constructor
-    // Override in child classes that need lazy initialization
-    }
+    // Hooks (override in child classes)
+    async ensureRepositoryInitialized() {}
     async beforeInsertOperation(_dto, _user, _queryRunner) {}
     async afterInsertOperation(_entity, _user, _queryRunner) {}
     async beforeUpdateOperation(_dto, _user, _queryRunner) {}
@@ -433,9 +394,7 @@ import { In } from 'typeorm';
             isRaw: false
         };
     }
-    // ---------------------------------------------------------------------
-    // DTO <-> ENTITY CONVERSION
-    // ---------------------------------------------------------------------
+    // DTO conversion
     async convertRequestDtoToEntity(dto, user) {
         return Array.isArray(dto) ? await this.convertArrayDtoToEntities(dto, user) : [
             await this.convertSingleDtoToEntity(dto, user)

package/fesm/classes/request-scoped-api.service.js

@@ -20,18 +20,7 @@ function _ts_decorate(decorators, target, key, desc) {
 import { Injectable, Scope } from '@nestjs/common';
 import { ApiService } from './api-service.class';
 export class RequestScopedApiService extends ApiService {
-    /**
-   * Ensures repository is initialized before any database access
-   * CRITICAL: Automatically called by ApiService before all CRUD operations
-   *
-   * This method:
-   * 1. Calls resolveEntity() to get the entity class
-   * 2. Calls getDataSourceProvider() to get the provider
-   * 3. Loads the repository from the provider
-   * 4. Marks initialization as complete
-   *
-   * @internal - Called automatically, do not call manually
-   */ async ensureRepositoryInitialized() {
+    async ensureRepositoryInitialized() {
         if (!this.repositoryInitialized) {
             const entity = this.resolveEntity();
             const provider = this.getDataSourceProvider();
@@ -39,26 +28,7 @@ export class RequestScopedApiService extends ApiService {
             this.repositoryInitialized = true;
         }
     }
-    /**
-   * Helper method to initialize additional repositories
-   * Useful when service needs multiple repositories beyond the primary entity repository
-   *
-   * @param entities - Array of entity classes to load repositories for
-   * @returns Array of initialized repositories in the same order as entities
-   *
-   * @example
-   * ```typescript
-   * protected override async ensureRepositoryInitialized(): Promise<void> {
-   *   await super.ensureRepositoryInitialized();
-   *
-   *   if (this.configService.isCompanyFeatureEnabled() && !this.permissionRepository) {
-   *     [this.permissionRepository] = await this.initializeAdditionalRepositories([
-   *       UserCompanyPermission
-   *     ]);
-   *   }
-   * }
-   * ```
-   */ async initializeAdditionalRepositories(entities) {
+    /** Initialize additional repositories beyond the primary entity */ async initializeAdditionalRepositories(entities) {
         const provider = this.getDataSourceProvider();
         const repositories = [];
         for (const entity of entities){
@@ -66,31 +36,12 @@ export class RequestScopedApiService extends ApiService {
         }
         return repositories;
     }
-    /**
-   * Helper method to get the DataSource
-   * Useful when service needs direct DataSource access for transactions or custom queries
-   *
-   * @returns DataSource instance
-   *
-   * @example
-   * ```typescript
-   * protected override async ensureRepositoryInitialized(): Promise<void> {
-   *   await super.ensureRepositoryInitialized();
-   *
-   *   if (!this.dataSource) {
-   *     this.dataSource = await this.getDataSourceForService();
-   *   }
-   * }
-   * ```
-   */ async getDataSourceForService() {
+    /** Get DataSource for direct access (transactions, custom queries) */ async getDataSourceForService() {
         const provider = this.getDataSourceProvider();
         return await provider.getDataSource();
     }
     constructor(...args){
-        super(...args), /**
-   * Tracks whether repository has been initialized
-   * Automatically managed by ensureRepositoryInitialized()
-   */ _define_property(this, "repositoryInitialized", false);
+        super(...args), _define_property(this, "repositoryInitialized", false);
     }
 }
 RequestScopedApiService = _ts_decorate([

package/fesm/classes/winston.logger.class.js

@@ -20,9 +20,7 @@ import * as TransportModule from 'winston-transport';
 const Transport = TransportModule.default || TransportModule;
 import * as DailyRotateFileModule from 'winston-daily-rotate-file';
 const DailyRotateFile = DailyRotateFileModule.default || DailyRotateFileModule;
-// =============================================================================
-// CONFIGURATION (from envConfig)
-// =============================================================================
+// Configuration
 const logConfig = envConfig.getLogConfig();
 const LOG_DIR = logConfig.dir;
 const LOG_LEVEL = logConfig.level;
@@ -35,9 +33,7 @@ if (!existsSync(LOG_DIR)) {
         recursive: true
     });
 }
-// =============================================================================
-// CUSTOM FORMATS
-// =============================================================================
+// Custom Formats
 /**
  * Custom format for structured logging
  * Includes: timestamp, level, context, requestId, userId, message, metadata
@@ -67,9 +63,7 @@ if (!existsSync(LOG_DIR)) {
     const stackTrace = stack ? `\n${stack}` : '';
     return `${timestamp} [${level.toUpperCase().padEnd(7)}] [${ctx}]${endpoint}${status}${time}${reqId}${user} ${message}${stackTrace}`;
 });
-// =============================================================================
-// TRANSPORTS
-// =============================================================================
+// Transports
 /**
  * Daily rotating file transport for all logs
  */ const combinedRotateTransport = new DailyRotateFile({
@@ -90,9 +84,7 @@ if (!existsSync(LOG_DIR)) {
     maxFiles: LOG_MAX_FILES,
     level: 'error'
 });
-// =============================================================================
-// TENANT-AWARE TRANSPORT
-// =============================================================================
+// Tenant-Aware Transport
 /**
  * Cache for tenant-specific transports
  * Avoids creating new transport instances for each log entry
@@ -158,9 +150,7 @@ if (!existsSync(LOG_DIR)) {
         stack: true
     }), devConsoleFormat)
 });
-// =============================================================================
-// LOGGER INSTANCES
-// =============================================================================
+// Logger Instances
 /**
  * Development logger configuration
  * - Console output with colors
@@ -198,9 +188,7 @@ if (!existsSync(LOG_DIR)) {
     ],
     exitOnError: false
 });
-// =============================================================================
-// EXPORTS
-// =============================================================================
+// Exports
 /**
  * Winston logger instance
  * - DEV: Console output with colors

package/fesm/constants/index.js

@@ -1,29 +1,14 @@
-/**
- * Constants for the common module
- *
- * This file centralizes all constants used across the module:
- * - Metadata keys for decorators
- * - Injection tokens for DI
- * - Header names
- */ // =============================================================================
-// METADATA KEYS (used with @SetMetadata decorator)
-// =============================================================================
-/** Metadata key for public routes (skip authentication) */ export const IS_PUBLIC_KEY = 'isPublic';
-/** Metadata key for required permissions */ export const PERMISSIONS_KEY = 'permissions';
-// =============================================================================
-// INJECTION TOKENS (used with @Inject decorator)
-// =============================================================================
-/** Injection token for cache instance */ export const CACHE_INSTANCE = 'CACHE_INSTANCE';
-/** Injection token for permission guard configuration */ export const PERMISSION_GUARD_CONFIG = 'PERMISSION_GUARD_CONFIG';
-/** Injection token for logger instance */ export const LOGGER_INSTANCE = 'LOGGER_INSTANCE';
-// =============================================================================
-// HEADER NAMES
-// =============================================================================
-/** Header for idempotency key */ export const IDEMPOTENCY_KEY_HEADER = 'x-idempotency-key';
-/** Header for request ID (correlation) */ export const REQUEST_ID_HEADER = 'x-request-id';
-/** Header for client type (browser, mobile, api) */ export const CLIENT_TYPE_HEADER = 'x-client-type';
-// =============================================================================
-// CACHE KEY PREFIXES (Generic - usable by any package)
-// =============================================================================
-/** Cache key prefix for user permissions (generic, not auth-specific) */ export const PERMISSIONS_CACHE_PREFIX = 'permissions';
-/** Cache key prefix for idempotency */ export const IDEMPOTENCY_CACHE_PREFIX = 'idempotency';
+// Metadata keys
+export const IS_PUBLIC_KEY = 'isPublic';
+export const PERMISSIONS_KEY = 'permissions';
+// Injection tokens
+export const CACHE_INSTANCE = 'CACHE_INSTANCE';
+export const PERMISSION_GUARD_CONFIG = 'PERMISSION_GUARD_CONFIG';
+export const LOGGER_INSTANCE = 'LOGGER_INSTANCE';
+// Header names
+export const IDEMPOTENCY_KEY_HEADER = 'x-idempotency-key';
+export const REQUEST_ID_HEADER = 'x-request-id';
+export const CLIENT_TYPE_HEADER = 'x-client-type';
+// Cache key prefixes
+export const PERMISSIONS_CACHE_PREFIX = 'permissions';
+export const IDEMPOTENCY_CACHE_PREFIX = 'idempotency';