@flusys/nestjs-shared 1.0.0-beta → 1.0.0-rc

package/interfaces/module-config.interface.d.ts

@@ -0,0 +1,6 @@
+import { DatabaseMode } from '@flusys/nestjs-core';
+export interface IModuleConfigService {
+    getDatabaseMode(): DatabaseMode;
+    isMultiTenant(): boolean;
+    isCompanyFeatureEnabled(): boolean;
+}

package/interfaces/permission.interface.d.ts

@@ -11,7 +11,6 @@ export interface LegacyPermissionConfig {
 export type PermissionConfig = PermissionCondition | LegacyPermissionConfig | string[];
 export interface PermissionGuardConfig {
     enableCompanyFeature?: boolean;
-    cacheKeyPrefix?: string;
     userPermissionKeyFormat?: string;
     companyPermissionKeyFormat?: string;
 }

package/modules/utils/utils.service.d.ts

@@ -1,6 +1,14 @@
-import { HybridCache } from '@flusys/nestjs-shared/classes';
+import { HybridCache } from '../../classes/hybrid-cache.class';
+export declare const DEFAULT_PHONE_REGEX: RegExp;
+export declare const DEFAULT_PHONE_COUNTRY_CODE = "+88";
+export interface PhoneValidationConfig {
+    regex: RegExp;
+    countryCode: string;
+}
 export declare class UtilsService {
-    constructor();
+    private readonly logger;
+    private phoneConfig;
+    setPhoneValidationConfig(config: PhoneValidationConfig): void;
     getCacheKey(entityName: string, params: any, entityId?: string, tenantId?: string): string;
     trackCacheKey(cacheKey: string, entityName: string, cacheManager: HybridCache, entityId?: string, tenantId?: string): Promise<void>;
     clearCache(entityName: string, cacheManager: HybridCache, entityId?: string, tenantId?: string): Promise<void>;
@@ -16,6 +24,4 @@ export declare class UtilsService {
         columnName: string;
         value: string;
     };
-    getOtpEmailFormat(otp: number, userName?: string | null | undefined): string;
-    getResetPasswordEmailFormat(resetLink: string, userName?: string | null | undefined): string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flusys/nestjs-shared",
-  "version": "1.0.0-beta",
+  "version": "1.0.0-rc",
   "description": "Common shared utilities for Flusys NestJS applications",
   "main": "cjs/index.js",
   "module": "fesm/index.js",
@@ -88,7 +88,7 @@
     }
   },
   "peerDependencies": {
-    "@keyv/redis": "^3.0.0",
+    "@keyv/redis": "^5.0.0",
     "@nestjs/common": "^10.0.0 || ^11.0.0",
     "@nestjs/config": "^3.0.0 || ^4.0.0",
     "@nestjs/core": "^10.0.0 || ^11.0.0",
@@ -96,7 +96,7 @@
     "@nestjs/passport": "^10.0.0 || ^11.0.0",
     "@nestjs/swagger": "^7.0.0 || ^11.0.0",
     "@nestjs/typeorm": "^10.0.0 || ^11.0.0",
-    "cacheable": "^1.0.0",
+    "cacheable": "^2.0.0",
     "class-transformer": "^0.5.0",
     "class-validator": "^0.14.0",
     "keyv": "^5.0.0",
@@ -105,6 +105,6 @@
     "winston-daily-rotate-file": "^5.0.0"
   },
   "dependencies": {
-    "@flusys/nestjs-core": "1.0.0-beta"
+    "@flusys/nestjs-core": "1.0.0-rc"
   }
 }

package/utils/error-handler.util.d.ts

@@ -1,13 +1,27 @@
 import { Logger } from '@nestjs/common';
+export interface IErrorContext {
+    operation?: string;
+    entity?: string;
+    userId?: string;
+    id?: string;
+    companyId?: string;
+    branchId?: string;
+    sectionId?: string;
+    data?: Record<string, unknown>;
+}
+export interface ISanitizedError {
+    message: string;
+    code?: string;
+    statusCode?: number;
+    stack?: string;
+}
 export declare class ErrorHandler {
-    static getErrorMessage(error: unknown): string;
-    static getErrorStack(error: unknown): string | undefined;
-    static createErrorContext(error: unknown, context?: {
-        operation?: string;
-        entity?: string;
-        userId?: string;
-        [key: string]: unknown;
-    }): {
+    static getErrorMessage(error: unknown, sanitizeForClient?: boolean): string;
+    private static containsSensitiveData;
+    static getErrorStack(error: unknown, forClient?: boolean): string | undefined;
+    static createClientError(error: unknown, statusCode?: number, code?: string): ISanitizedError;
+    private static sanitizeContextForLogging;
+    static createErrorContext(error: unknown, context?: IErrorContext): {
         error: {
             message: string;
             stack?: string;
@@ -15,10 +29,6 @@ export declare class ErrorHandler {
         };
         context?: Record<string, unknown>;
     };
-    static logError(logger: Logger, error: unknown, operation: string, context?: {
-        entity?: string;
-        userId?: string;
-        [key: string]: unknown;
-    }): void;
+    static logError(logger: Logger, error: unknown, operation: string, context?: Omit<IErrorContext, 'operation'>): void;
     static rethrowError(error: unknown): never;
 }

package/utils/html-sanitizer.util.d.ts

@@ -0,0 +1,3 @@
+export declare function escapeHtml(str: string): string;
+export declare function escapeHtmlVariables(variables: Record<string, unknown>): Record<string, string>;
+export declare function containsHtmlContent(str: string): boolean;

package/utils/index.d.ts

@@ -1 +1,3 @@
 export * from './error-handler.util';
+export * from './html-sanitizer.util';
+export * from './query-helpers.util';

package/utils/query-helpers.util.d.ts

@@ -0,0 +1,16 @@
+import { ObjectLiteral, SelectQueryBuilder } from 'typeorm';
+import { ILoggedUserInfo } from '../interfaces';
+export interface ICompanyFilterConfig {
+    isCompanyFeatureEnabled: boolean;
+    entityAlias: string;
+    columnName?: string;
+}
+export declare function applyCompanyFilter<T extends ObjectLiteral>(query: SelectQueryBuilder<T>, config: ICompanyFilterConfig, user: ILoggedUserInfo | null | undefined): SelectQueryBuilder<T>;
+export declare function buildCompanyWhereCondition<T extends Record<string, unknown>>(baseWhere: T, isCompanyFeatureEnabled: boolean, user: ILoggedUserInfo | null | undefined): T & {
+    companyId?: string;
+};
+export interface ICompanyEnabled {
+    companyId?: string | null;
+}
+export declare function hasCompanyId<T>(entity: T): entity is T & ICompanyEnabled;
+export declare function validateCompanyOwnership<T>(entity: T, user: ILoggedUserInfo | null | undefined, isCompanyFeatureEnabled: boolean, entityName: string): void;

package/cjs/interfaces/base-query.interface.js

@@ -1,6 +0,0 @@
-/**
- * Base query DTO interface for list/search endpoints
- */ "use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});

package/fesm/interfaces/base-query.interface.js

@@ -1,3 +0,0 @@
-/**
- * Base query DTO interface for list/search endpoints
- */ export { };

package/interfaces/base-query.interface.d.ts

@@ -1,7 +0,0 @@
-export interface IBaseQueryDto {
-    search?: string;
-    sortBy?: string;
-    sortOrder?: 'ASC' | 'DESC';
-    page?: number;
-    limit?: number;
-}