@saihu/common 1.1.91 → 1.1.92

package/dist/errors/application-error.filter.d.ts

@@ -0,0 +1,24 @@
+import { ExceptionFilter, ArgumentsHost } from '@nestjs/common';
+import { ApplicationError } from '../errors/application.error';
+export declare class ApplicationErrorFilter implements ExceptionFilter {
+    private readonly logger;
+    private readonly SENSITIVE_KEYS;
+    private readonly MAX_DETAILS_LENGTH;
+    catch(exception: ApplicationError, host: ArgumentsHost): void;
+    private mapErrorCodeToHttpStatus;
+    /**
+     * Recursively sanitize sensitive information from details object
+     * Handles nested objects like { headers: { authorization: "..." } }
+     */
+    private sanitizeDetails;
+    /**
+     * Recursively sanitize an object
+     */
+    private sanitizeObject;
+    /**
+     * Truncate a string to a maximum length
+     * Adds "... (truncated)" suffix if truncated
+     */
+    private truncateString;
+}
+//# sourceMappingURL=application-error.filter.d.ts.map

package/dist/errors/application-error.filter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"application-error.filter.d.ts","sourceRoot":"","sources":["../../src/errors/application-error.filter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAS,aAAa,EAAU,MAAM,gBAAgB,CAAC;AAE/E,OAAO,EAAE,gBAAgB,EAAc,MAAM,6BAA6B,CAAC;AAG3E,qBACa,sBAAuB,YAAW,eAAe;IAC5D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA2C;IAGlE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAS7B;IAGF,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAQ;IAE3C,KAAK,CAAC,SAAS,EAAE,gBAAgB,EAAE,IAAI,EAAE,aAAa;IA8DtD,OAAO,CAAC,wBAAwB;IA0BhC;;;OAGG;IACH,OAAO,CAAC,eAAe;IAUvB;;OAEG;IACH,OAAO,CAAC,cAAc;IAmCtB;;;OAGG;IACH,OAAO,CAAC,cAAc;CAQvB"}

package/dist/errors/application-error.filter.js

@@ -0,0 +1,152 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.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;
+};
+var ApplicationErrorFilter_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApplicationErrorFilter = void 0;
+const common_1 = require("@nestjs/common");
+const application_error_1 = require("../errors/application.error");
+const dto_1 = require("../dto");
+let ApplicationErrorFilter = ApplicationErrorFilter_1 = class ApplicationErrorFilter {
+    constructor() {
+        this.logger = new common_1.Logger(ApplicationErrorFilter_1.name);
+        // Sensitive keys to redact from logs
+        this.SENSITIVE_KEYS = [
+            'password',
+            'token',
+            'accessToken',
+            'refreshToken',
+            'authorization',
+            'secret',
+            'apiKey',
+            'creditCard',
+        ];
+        // Maximum length for logged details to prevent log explosion
+        this.MAX_DETAILS_LENGTH = 1000;
+    }
+    catch(exception, host) {
+        // Guard: ensure we're in HTTP context
+        if (host.getType() !== 'http') {
+            this.logger.warn(`ApplicationErrorFilter called in non-HTTP context: ${host.getType()}`);
+            return;
+        }
+        const ctx = host.switchToHttp();
+        const response = ctx.getResponse();
+        // Additional guard: ensure response exists
+        if (!response) {
+            this.logger.warn('Response object not available in HTTP context');
+            return;
+        }
+        // Map application error codes to HTTP status codes
+        const statusCode = this.mapErrorCodeToHttpStatus(exception.code);
+        // Get the cause as Error type for proper access to properties
+        const cause = exception.cause;
+        // Redact sensitive information from details before logging
+        const sanitizedDetails = this.sanitizeDetails(exception.details);
+        // Stringify and truncate details to prevent log explosion
+        const detailsString = sanitizedDetails
+            ? this.truncateString(JSON.stringify(sanitizedDetails), this.MAX_DETAILS_LENGTH)
+            : null;
+        // Log the error with full context (sanitized and truncated)
+        const logMessage = [
+            `ApplicationError: ${exception.code}`,
+            `Message: ${exception.message}`,
+            detailsString ? `Details: ${detailsString}` : null,
+            cause ? `Cause: ${cause.message}` : null,
+        ]
+            .filter(Boolean)
+            .join(' | ');
+        this.logger.error(logMessage, exception.stack);
+        // Log cause stack separately if it exists
+        if (cause === null || cause === void 0 ? void 0 : cause.stack) {
+            this.logger.error(`Caused by: ${cause.stack}`);
+        }
+        // Create standardized response using BaseResponseDto for backward compatibility
+        const errorResponse = dto_1.BaseResponseDto.error(statusCode, exception.message);
+        // Extend with application error code for new clients
+        // Existing clients ignore this field, new clients can use it for specific handling
+        errorResponse.errorCode = exception.code;
+        response.status(statusCode).json(errorResponse);
+    }
+    mapErrorCodeToHttpStatus(code) {
+        // Explicit mappings for known error codes
+        const mapping = {
+            [application_error_1.ErrorCodes.DATA_SOURCE_UNAVAILABLE]: 503, // Service Unavailable
+            [application_error_1.ErrorCodes.DATA_SOURCE_AUTH_FAILED]: 502, // Bad Gateway (upstream auth failed)
+            [application_error_1.ErrorCodes.RESOURCE_NOT_FOUND]: 404, // Not Found
+            [application_error_1.ErrorCodes.INVALID_INPUT]: 400, // Bad Request
+            [application_error_1.ErrorCodes.EXTERNAL_SERVICE_ERROR]: 502, // Bad Gateway
+            [application_error_1.ErrorCodes.INTERNAL_ERROR]: 500, // Internal Server Error
+        };
+        // Return explicit mapping if it exists
+        if (code in mapping) {
+            return mapping[code];
+        }
+        // Smart defaults for unknown codes:
+        // - Codes starting with "INTERNAL" -> 500 (internal server errors)
+        // - Everything else -> 400 (safer default for business/validation errors)
+        if (code.startsWith('INTERNAL')) {
+            return 500;
+        }
+        return 400; // Default to 400 for unknown business/validation errors
+    }
+    /**
+     * Recursively sanitize sensitive information from details object
+     * Handles nested objects like { headers: { authorization: "..." } }
+     */
+    sanitizeDetails(details) {
+        if (!details) {
+            return undefined;
+        }
+        return this.sanitizeObject(details);
+    }
+    /**
+     * Recursively sanitize an object
+     */
+    sanitizeObject(obj) {
+        if (obj === null || obj === undefined) {
+            return obj;
+        }
+        // Handle arrays
+        if (Array.isArray(obj)) {
+            return obj.map((item) => this.sanitizeObject(item));
+        }
+        // Handle objects
+        if (typeof obj === 'object') {
+            const sanitized = {};
+            for (const key of Object.keys(obj)) {
+                const lowerKey = key.toLowerCase();
+                // Check if key contains sensitive information
+                if (this.SENSITIVE_KEYS.some((sensitive) => lowerKey.includes(sensitive))) {
+                    sanitized[key] = '[REDACTED]';
+                }
+                else {
+                    // Recursively sanitize nested objects
+                    sanitized[key] = this.sanitizeObject(obj[key]);
+                }
+            }
+            return sanitized;
+        }
+        // Return primitives as-is
+        return obj;
+    }
+    /**
+     * Truncate a string to a maximum length
+     * Adds "... (truncated)" suffix if truncated
+     */
+    truncateString(str, maxLength) {
+        if (str.length <= maxLength) {
+            return str;
+        }
+        const suffix = '... (truncated)';
+        return str.substring(0, maxLength - suffix.length) + suffix;
+    }
+};
+exports.ApplicationErrorFilter = ApplicationErrorFilter;
+exports.ApplicationErrorFilter = ApplicationErrorFilter = ApplicationErrorFilter_1 = __decorate([
+    (0, common_1.Catch)(application_error_1.ApplicationError)
+], ApplicationErrorFilter);

package/dist/errors/application.error.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Common error codes for convenience.
+ * You can use these or define your own domain-specific codes.
+ */
+export declare const ErrorCodes: {
+    readonly DATA_SOURCE_UNAVAILABLE: "DATA_SOURCE_UNAVAILABLE";
+    readonly DATA_SOURCE_AUTH_FAILED: "DATA_SOURCE_AUTH_FAILED";
+    readonly RESOURCE_NOT_FOUND: "RESOURCE_NOT_FOUND";
+    readonly INVALID_INPUT: "INVALID_INPUT";
+    readonly EXTERNAL_SERVICE_ERROR: "EXTERNAL_SERVICE_ERROR";
+    readonly INTERNAL_ERROR: "INTERNAL_ERROR";
+};
+export declare class ApplicationError extends Error {
+    readonly code: string;
+    readonly details?: Record<string, any>;
+    readonly cause?: Error;
+    constructor(code: string, message: string, details?: Record<string, any>, cause?: Error);
+    static withCode(code: string, message: string, details?: Record<string, any>): ApplicationError;
+    static dataSourceUnavailable(message: string, cause?: Error): ApplicationError;
+    static dataSourceAuthFailed(message: string, details?: Record<string, any>): ApplicationError;
+    static notFound(resource: string, id: string | number): ApplicationError;
+    static invalidInput(message: string, details?: Record<string, any>): ApplicationError;
+    static externalServiceError(service: string, message: string, cause?: Error): ApplicationError;
+    static internalError(message: string, cause?: Error): ApplicationError;
+}
+//# sourceMappingURL=application.error.d.ts.map

package/dist/errors/application.error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"application.error.d.ts","sourceRoot":"","sources":["../../src/errors/application.error.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,UAAU;;;;;;;CAcb,CAAC;AAEX,qBAAa,gBAAiB,SAAQ,KAAK;IACzC,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9C,SAAgB,KAAK,CAAC,EAAE,KAAK,CAAC;gBAG5B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC7B,KAAK,CAAC,EAAE,KAAK;IAYf,MAAM,CAAC,QAAQ,CACb,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC5B,gBAAgB;IAKnB,MAAM,CAAC,qBAAqB,CAC1B,OAAO,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,KAAK,GACZ,gBAAgB;IASnB,MAAM,CAAC,oBAAoB,CACzB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC5B,gBAAgB;IAQnB,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,gBAAgB;IAQxE,MAAM,CAAC,YAAY,CACjB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC5B,gBAAgB;IAInB,MAAM,CAAC,oBAAoB,CACzB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,KAAK,GACZ,gBAAgB;IASnB,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,gBAAgB;CAQvE"}

package/dist/errors/application.error.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApplicationError = exports.ErrorCodes = void 0;
+/**
+ * Common error codes for convenience.
+ * You can use these or define your own domain-specific codes.
+ */
+exports.ErrorCodes = {
+    // Data source errors
+    DATA_SOURCE_UNAVAILABLE: 'DATA_SOURCE_UNAVAILABLE',
+    DATA_SOURCE_AUTH_FAILED: 'DATA_SOURCE_AUTH_FAILED',
+    // Business logic errors
+    RESOURCE_NOT_FOUND: 'RESOURCE_NOT_FOUND',
+    INVALID_INPUT: 'INVALID_INPUT',
+    // External service errors
+    EXTERNAL_SERVICE_ERROR: 'EXTERNAL_SERVICE_ERROR',
+    // Generic
+    INTERNAL_ERROR: 'INTERNAL_ERROR',
+};
+class ApplicationError extends Error {
+    constructor(code, message, details, cause) {
+        // Store cause manually for ES2018 compatibility
+        super(message);
+        this.name = 'ApplicationError';
+        this.code = code;
+        this.details = details;
+        this.cause = cause;
+        Error.captureStackTrace(this, this.constructor);
+    }
+    // Generic factory - use this for any custom error code
+    static withCode(code, message, details) {
+        return new ApplicationError(code, message, details);
+    }
+    // Convenience factory methods for common error types
+    static dataSourceUnavailable(message, cause) {
+        return new ApplicationError(exports.ErrorCodes.DATA_SOURCE_UNAVAILABLE, message, undefined, cause);
+    }
+    static dataSourceAuthFailed(message, details) {
+        return new ApplicationError(exports.ErrorCodes.DATA_SOURCE_AUTH_FAILED, message, details);
+    }
+    static notFound(resource, id) {
+        return new ApplicationError(exports.ErrorCodes.RESOURCE_NOT_FOUND, `${resource} with id ${id} not found`, { resource, id });
+    }
+    static invalidInput(message, details) {
+        return new ApplicationError(exports.ErrorCodes.INVALID_INPUT, message, details);
+    }
+    static externalServiceError(service, message, cause) {
+        return new ApplicationError(exports.ErrorCodes.EXTERNAL_SERVICE_ERROR, `${service}: ${message}`, { service }, cause);
+    }
+    static internalError(message, cause) {
+        return new ApplicationError(exports.ErrorCodes.INTERNAL_ERROR, message, undefined, cause);
+    }
+}
+exports.ApplicationError = ApplicationError;

package/dist/errors/index.d.ts

@@ -0,0 +1,3 @@
+export * from './application.error';
+export * from './application-error.filter';
+//# sourceMappingURL=index.d.ts.map

package/dist/errors/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/errors/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,4BAA4B,CAAC"}

package/dist/errors/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./application.error"), exports);
+__exportStar(require("./application-error.filter"), exports);

package/dist/index.d.ts

@@ -7,6 +7,7 @@ export * from './util';
 export * from './logger';
 export * from './messaging';
 export * from './decorators';
+export * from './errors';
 export { SaihuCommonModule } from './saihu-common.module';
 export { BaseService } from './services/base.service';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC"}

package/dist/index.js

@@ -24,6 +24,7 @@ __exportStar(require("./util"), exports);
 __exportStar(require("./logger"), exports);
 __exportStar(require("./messaging"), exports);
 __exportStar(require("./decorators"), exports);
+__exportStar(require("./errors"), exports);
 var saihu_common_module_1 = require("./saihu-common.module");
 Object.defineProperty(exports, "SaihuCommonModule", { enumerable: true, get: function () { return saihu_common_module_1.SaihuCommonModule; } });
 var base_service_1 = require("./services/base.service");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saihu/common",
-  "version": "1.1.91",
+  "version": "1.1.92",
   "description": "Common utilities for NestJS applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",