@nest-omni/core 1.0.2 → 1.0.5

package/src/filters/bad-request.filter.ts

@@ -0,0 +1,67 @@
+import type { ArgumentsHost, ExceptionFilter } from '@nestjs/common';
+import { Catch, HttpException } from '@nestjs/common';
+import { Request, Response } from 'express';
+import { EntityNotFoundError } from 'typeorm';
+import { I18nContext, I18nValidationException } from 'nestjs-i18n';
+
+@Catch()
+export class HttpExceptionFilter implements ExceptionFilter {
+  catch(exception, host: ArgumentsHost) {
+    const i18n = I18nContext.current(host);
+    const ctx = host.switchToHttp();
+    const response: Response = ctx.getResponse();
+    const request: Request = ctx.getRequest();
+    let statusCode =
+      exception instanceof HttpException ? exception.getStatus() : 500;
+    let error =
+      exception instanceof HttpException
+        ? exception.message
+        : 'Internal server error';
+
+    if (exception instanceof EntityNotFoundError) {
+      statusCode = 404;
+      error = 'Entity not found';
+    }
+
+    if (statusCode === 500) {
+      console.error(exception);
+    }
+
+    const getFirstError = (error, property = '') => {
+      if (error?.children?.length > 0) {
+        const firstError = error.children[0];
+        firstError['property'] = `${property}.${firstError['property']}`;
+        return getFirstError(firstError, firstError.property);
+      }
+
+      return error;
+    };
+
+    if (exception instanceof I18nValidationException) {
+      const firstErros = getFirstError(
+        exception.errors[0],
+        exception.errors[0].property,
+      );
+      const constraint = Object.values(firstErros.constraints)[0] as string;
+      const [translationKey, argsString] = constraint.split('|');
+      const args = !!argsString ? JSON.parse(argsString) : {};
+      error = i18n.translate(translationKey, {
+        args: {
+          property: firstErros.property,
+          value: firstErros.value,
+          constraints: firstErros.constraints,
+          ...args,
+        },
+      });
+    }
+
+    const parseJson = {
+      code: statusCode,
+      msg: error,
+      requestId: request.id,
+      timestamp: new Date().toISOString(),
+    };
+
+    return response.status(200).json(parseJson);
+  }
+}

package/{dist → src}/filters/constraint-errors.js

@@ -1,7 +1,7 @@
 "use strict";
+/* eslint-disable @typescript-eslint/naming-convention */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.constraintErrors = void 0;
 exports.constraintErrors = {
     UQ_97672ac88f789774dd47f7c8be3: 'error.unique.email',
 };
-//# sourceMappingURL=constraint-errors.js.map

package/src/filters/constraint-errors.ts

@@ -0,0 +1,5 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+
+export const constraintErrors: Record<string, string> = {
+  UQ_97672ac88f789774dd47f7c8be3: 'error.unique.email',
+};

package/{dist → src}/filters/index.js

@@ -17,4 +17,3 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./bad-request.filter"), exports);
 __exportStar(require("./constraint-errors"), exports);
 __exportStar(require("./query-failed.filter"), exports);
-//# sourceMappingURL=index.js.map

package/src/filters/index.ts

@@ -0,0 +1,3 @@
+export * from './bad-request.filter';
+export * from './constraint-errors';
+export * from './query-failed.filter';

package/src/filters/query-failed.filter.js

@@ -0,0 +1,81 @@
+"use strict";
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+var __setFunctionName = (this && this.__setFunctionName) || function (f, name, prefix) {
+    if (typeof name === "symbol") name = name.description ? "[".concat(name.description, "]") : "";
+    return Object.defineProperty(f, "name", { configurable: true, value: prefix ? "".concat(prefix, " ", name) : name });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryFailedFilter = void 0;
+const common_1 = require("@nestjs/common");
+const http_1 = require("http");
+const typeorm_1 = require("typeorm");
+const constraint_errors_1 = require("./constraint-errors");
+let QueryFailedFilter = (() => {
+    let _classDecorators = [(0, common_1.Catch)(typeorm_1.QueryFailedError)];
+    let _classDescriptor;
+    let _classExtraInitializers = [];
+    let _classThis;
+    var QueryFailedFilter = _classThis = class {
+        constructor(reflector) {
+            this.reflector = reflector;
+        }
+        catch(exception, host) {
+            var _a;
+            const ctx = host.switchToHttp();
+            const response = ctx.getResponse();
+            const status = ((_a = exception.constraint) === null || _a === void 0 ? void 0 : _a.startsWith('UQ'))
+                ? common_1.HttpStatus.CONFLICT
+                : common_1.HttpStatus.INTERNAL_SERVER_ERROR;
+            response.status(status).json({
+                code: status,
+                error: http_1.STATUS_CODES[status],
+                msg: exception.constraint
+                    ? constraint_errors_1.constraintErrors[exception.constraint]
+                    : undefined,
+            });
+        }
+    };
+    __setFunctionName(_classThis, "QueryFailedFilter");
+    (() => {
+        const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
+        __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+        QueryFailedFilter = _classThis = _classDescriptor.value;
+        if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        __runInitializers(_classThis, _classExtraInitializers);
+    })();
+    return QueryFailedFilter = _classThis;
+})();
+exports.QueryFailedFilter = QueryFailedFilter;

package/src/filters/query-failed.filter.ts

@@ -0,0 +1,32 @@
+import type { ArgumentsHost, ExceptionFilter } from '@nestjs/common';
+import { Catch, HttpStatus } from '@nestjs/common';
+import { Reflector } from '@nestjs/core';
+import { STATUS_CODES } from 'http';
+import { QueryFailedError } from 'typeorm';
+
+import { constraintErrors } from './constraint-errors';
+
+@Catch(QueryFailedError)
+export class QueryFailedFilter implements ExceptionFilter<QueryFailedError> {
+  constructor(public reflector: Reflector) {}
+
+  catch(
+    exception: QueryFailedError & { constraint?: string },
+    host: ArgumentsHost,
+  ) {
+    const ctx = host.switchToHttp();
+    const response = ctx.getResponse();
+
+    const status = exception.constraint?.startsWith('UQ')
+      ? HttpStatus.CONFLICT
+      : HttpStatus.INTERNAL_SERVER_ERROR;
+
+    response.status(status).json({
+      code: status,
+      error: STATUS_CODES[status],
+      msg: exception.constraint
+        ? constraintErrors[exception.constraint]
+        : undefined,
+    });
+  }
+}

package/src/health-checker/health-checker.controller.js

@@ -0,0 +1,104 @@
+"use strict";
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __setFunctionName = (this && this.__setFunctionName) || function (f, name, prefix) {
+    if (typeof name === "symbol") name = name.description ? "[".concat(name.description, "]") : "";
+    return Object.defineProperty(f, "name", { configurable: true, value: prefix ? "".concat(prefix, " ", name) : name });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthCheckerController = void 0;
+const ioredis_1 = __importDefault(require("ioredis"));
+const common_1 = require("@nestjs/common");
+const terminus_1 = require("@nestjs/terminus");
+const swagger_1 = require("@nestjs/swagger");
+let HealthCheckerController = (() => {
+    let _classDecorators = [(0, common_1.Controller)('health')];
+    let _classDescriptor;
+    let _classExtraInitializers = [];
+    let _classThis;
+    let _instanceExtraInitializers = [];
+    let _check_decorators;
+    var HealthCheckerController = _classThis = class {
+        constructor(configService, healthCheckService, ormIndicator, serviceIndicator, redisIndicator) {
+            this.configService = (__runInitializers(this, _instanceExtraInitializers), configService);
+            this.healthCheckService = healthCheckService;
+            this.ormIndicator = ormIndicator;
+            this.serviceIndicator = serviceIndicator;
+            this.redisIndicator = redisIndicator;
+            if (this.configService.isRedisEnabled) {
+                this.redis = new ioredis_1.default(this.configService.ioRedisConfig);
+            }
+        }
+        check() {
+            return __awaiter(this, void 0, void 0, function* () {
+                const indicator = [
+                    () => this.ormIndicator.pingCheck('database', { timeout: 1500 }),
+                ];
+                if (this.configService.isRedisEnabled) {
+                    indicator.push(() => this.redisIndicator.checkHealth('redis', {
+                        type: 'redis',
+                        client: this.redis,
+                        timeout: 1500,
+                    }));
+                }
+                return this.healthCheckService.check(indicator);
+            });
+        }
+    };
+    __setFunctionName(_classThis, "HealthCheckerController");
+    (() => {
+        const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
+        _check_decorators = [(0, common_1.Get)(), (0, terminus_1.HealthCheck)(), (0, swagger_1.ApiOperation)({ summary: 'Service health check' })];
+        __esDecorate(_classThis, null, _check_decorators, { kind: "method", name: "check", static: false, private: false, access: { has: obj => "check" in obj, get: obj => obj.check }, metadata: _metadata }, null, _instanceExtraInitializers);
+        __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+        HealthCheckerController = _classThis = _classDescriptor.value;
+        if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        __runInitializers(_classThis, _classExtraInitializers);
+    })();
+    return HealthCheckerController = _classThis;
+})();
+exports.HealthCheckerController = HealthCheckerController;

package/src/health-checker/health-checker.controller.ts

@@ -0,0 +1,51 @@
+import Redis from 'ioredis';
+import { Controller, Get } from '@nestjs/common';
+import type { HealthCheckResult } from '@nestjs/terminus';
+import {
+  HealthCheck,
+  HealthCheckService,
+  TypeOrmHealthIndicator,
+} from '@nestjs/terminus';
+
+import { ServiceHealthIndicator } from './health-indicators/service.indicator';
+import { ApiOperation } from '@nestjs/swagger';
+import { RedisHealthIndicator } from '@liaoliaots/nestjs-redis-health';
+import { ApiConfigService } from '../shared/services';
+
+@Controller('health')
+export class HealthCheckerController {
+  private readonly redis: Redis;
+
+  constructor(
+    private configService: ApiConfigService,
+    private healthCheckService: HealthCheckService,
+    private ormIndicator: TypeOrmHealthIndicator,
+    private serviceIndicator: ServiceHealthIndicator,
+    private redisIndicator: RedisHealthIndicator,
+  ) {
+    if (this.configService.isRedisEnabled) {
+      this.redis = new Redis(this.configService.ioRedisConfig);
+    }
+  }
+
+  @Get()
+  @HealthCheck()
+  @ApiOperation({ summary: 'Service health check' })
+  async check(): Promise<HealthCheckResult> {
+    const indicator = [
+      () => this.ormIndicator.pingCheck('database', { timeout: 1500 }),
+    ];
+
+    if (this.configService.isRedisEnabled) {
+      indicator.push(() =>
+        this.redisIndicator.checkHealth('redis', {
+          type: 'redis',
+          client: this.redis,
+          timeout: 1500,
+        }),
+      );
+    }
+
+    return this.healthCheckService.check(indicator);
+  }
+}

package/src/health-checker/health-checker.module.js

@@ -0,0 +1,69 @@
+"use strict";
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+var __setFunctionName = (this && this.__setFunctionName) || function (f, name, prefix) {
+    if (typeof name === "symbol") name = name.description ? "[".concat(name.description, "]") : "";
+    return Object.defineProperty(f, "name", { configurable: true, value: prefix ? "".concat(prefix, " ", name) : name });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthCheckerModule = void 0;
+const common_1 = require("@nestjs/common");
+const terminus_1 = require("@nestjs/terminus");
+const nestjs_redis_health_1 = require("@liaoliaots/nestjs-redis-health");
+const health_checker_controller_1 = require("./health-checker.controller");
+const service_indicator_1 = require("./health-indicators/service.indicator");
+const services_1 = require("../shared/services");
+let HealthCheckerModule = (() => {
+    let _classDecorators = [(0, common_1.Module)({
+            imports: [terminus_1.TerminusModule, nestjs_redis_health_1.RedisHealthModule],
+            controllers: [health_checker_controller_1.HealthCheckerController],
+            providers: [services_1.ApiConfigService, service_indicator_1.ServiceHealthIndicator],
+        })];
+    let _classDescriptor;
+    let _classExtraInitializers = [];
+    let _classThis;
+    var HealthCheckerModule = _classThis = class {
+    };
+    __setFunctionName(_classThis, "HealthCheckerModule");
+    (() => {
+        const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
+        __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+        HealthCheckerModule = _classThis = _classDescriptor.value;
+        if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        __runInitializers(_classThis, _classExtraInitializers);
+    })();
+    return HealthCheckerModule = _classThis;
+})();
+exports.HealthCheckerModule = HealthCheckerModule;

package/src/health-checker/health-checker.module.ts

@@ -0,0 +1,13 @@
+import { Module } from '@nestjs/common';
+import { TerminusModule } from '@nestjs/terminus';
+import { RedisHealthModule } from '@liaoliaots/nestjs-redis-health';
+import { HealthCheckerController } from './health-checker.controller';
+import { ServiceHealthIndicator } from './health-indicators/service.indicator';
+import { ApiConfigService } from '../shared/services';
+
+@Module({
+  imports: [TerminusModule, RedisHealthModule],
+  controllers: [HealthCheckerController],
+  providers: [ApiConfigService, ServiceHealthIndicator],
+})
+export class HealthCheckerModule {}

package/src/health-checker/health-indicators/service.indicator.js

@@ -0,0 +1,102 @@
+"use strict";
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __setFunctionName = (this && this.__setFunctionName) || function (f, name, prefix) {
+    if (typeof name === "symbol") name = name.description ? "[".concat(name.description, "]") : "";
+    return Object.defineProperty(f, "name", { configurable: true, value: prefix ? "".concat(prefix, " ", name) : name });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceHealthIndicator = void 0;
+const common_1 = require("@nestjs/common");
+const terminus_1 = require("@nestjs/terminus");
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+let ServiceHealthIndicator = (() => {
+    let _classDecorators = [(0, common_1.Injectable)()];
+    let _classDescriptor;
+    let _classExtraInitializers = [];
+    let _classThis;
+    let _classSuper = terminus_1.HealthIndicator;
+    var ServiceHealthIndicator = _classThis = class extends _classSuper {
+        constructor(clientProxy) {
+            super();
+            this.clientProxy = clientProxy;
+        }
+        isHealthy(eventName) {
+            return __awaiter(this, void 0, void 0, function* () {
+                try {
+                    if (!this.clientProxy) {
+                        return {
+                            [eventName]: {
+                                status: 'down',
+                            },
+                        };
+                    }
+                    const result = yield (0, rxjs_1.firstValueFrom)(this.clientProxy.send(eventName, { check: true }).pipe((0, operators_1.timeout)(10000)), {
+                        defaultValue: undefined,
+                    });
+                    return {
+                        [eventName]: result,
+                    };
+                }
+                catch (error) {
+                    throw new terminus_1.HealthCheckError(`${eventName} failed`, {
+                        [eventName]: error,
+                    });
+                }
+            });
+        }
+    };
+    __setFunctionName(_classThis, "ServiceHealthIndicator");
+    (() => {
+        var _a;
+        const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create((_a = _classSuper[Symbol.metadata]) !== null && _a !== void 0 ? _a : null) : void 0;
+        __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+        ServiceHealthIndicator = _classThis = _classDescriptor.value;
+        if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        __runInitializers(_classThis, _classExtraInitializers);
+    })();
+    return ServiceHealthIndicator = _classThis;
+})();
+exports.ServiceHealthIndicator = ServiceHealthIndicator;

package/src/health-checker/health-indicators/service.indicator.ts

@@ -0,0 +1,44 @@
+import { Inject, Injectable, Optional } from '@nestjs/common';
+import { ClientProxy } from '@nestjs/microservices';
+import type { HealthIndicatorResult } from '@nestjs/terminus';
+import { HealthCheckError, HealthIndicator } from '@nestjs/terminus';
+import { firstValueFrom } from 'rxjs';
+import { timeout } from 'rxjs/operators';
+
+@Injectable()
+export class ServiceHealthIndicator extends HealthIndicator {
+  constructor(
+    @Optional()
+    @Inject('NATS_SERVICE')
+    private readonly clientProxy?: ClientProxy,
+  ) {
+    super();
+  }
+
+  async isHealthy(eventName: string): Promise<HealthIndicatorResult> {
+    try {
+      if (!this.clientProxy) {
+        return {
+          [eventName]: {
+            status: 'down',
+          },
+        };
+      }
+
+      const result = await firstValueFrom(
+        this.clientProxy.send(eventName, { check: true }).pipe(timeout(10000)),
+        {
+          defaultValue: undefined,
+        },
+      );
+
+      return {
+        [eventName]: result,
+      };
+    } catch (error) {
+      throw new HealthCheckError(`${eventName} failed`, {
+        [eventName]: error,
+      });
+    }
+  }
+}

package/src/helpers/common.helper.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 将枚举值转换成数组
+ * @param Enum 枚举
+ */
+export declare function enumToArray<E>(Enum: any): E[];
+/**
+ * 生成随机字符串
+ * @param {number} length 生成长度
+ * @param {string} charSet 指定字符集
+ * @returns {string} 生成字符串
+ */
+export declare const randomString: (length?: number, charSet?: string) => string;
+/**
+ * 获取服务部署 IP 地址
+ */
+export declare function getIPAdress(): string;

package/{dist → src}/helpers/common.helper.js

@@ -2,12 +2,22 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getIPAdress = exports.randomString = exports.enumToArray = void 0;
 const os_1 = require("os");
+/**
+ * 将枚举值转换成数组
+ * @param Enum 枚举
+ */
 function enumToArray(Enum) {
     return Object.keys(Enum)
         .filter((key) => typeof Enum[key] === 'number')
         .map((key) => Enum[key]);
 }
 exports.enumToArray = enumToArray;
+/**
+ * 生成随机字符串
+ * @param {number} length 生成长度
+ * @param {string} charSet 指定字符集
+ * @returns {string} 生成字符串
+ */
 const randomString = (length = 8, charSet) => {
     charSet =
         charSet || 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
@@ -19,6 +29,9 @@ const randomString = (length = 8, charSet) => {
     return randomString;
 };
 exports.randomString = randomString;
+/**
+ * 获取服务部署 IP 地址
+ */
 function getIPAdress() {
     const interfaces = (0, os_1.networkInterfaces)();
     for (const devName in interfaces) {
@@ -34,4 +47,3 @@ function getIPAdress() {
     }
 }
 exports.getIPAdress = getIPAdress;
-//# sourceMappingURL=common.helper.js.map