@seas-computing/nestjs-healthcheck 0.0.8 → 0.0.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seas-computing/nestjs-healthcheck",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "A standalone healthcheck module for NestJS apps",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -10,8 +10,8 @@
     "dist/src"
   ],
   "scripts": {
-    "build": "rimraf dist/ && tsc",
-    "test": "nyc mocha --require ts-node/register \"test/**/*.test.ts\"",
+    "build": "rimraf dist/ && tsc --project tsconfig.publish.json",
+    "test": "nyc mocha --require ts-node/register \"src/**/__tests__/*.test.ts\"",
     "lint": "eslint --ext=ts,tsx,js ./src",
     "test:watch": "TS_NODE_TRANSPILE_ONLY=true mocha --watch",
     "typecheck": "tsc --noEmit",
@@ -35,17 +35,22 @@
     "typeorm": "^0.3.22"
   },
   "devDependencies": {
+    "@nestjs/platform-express": "^10.4.20",
     "@nestjs/swagger": "^7.4.2",
     "@nestjs/testing": "^10.1.0",
     "@seas-computing/eslint-config": "^0.0.3",
+    "@types/express": "^5.0.3",
     "@types/mocha": "^10.0.1",
     "@types/node": "^20.4.2",
     "@types/sinon": "^17.0.4",
+    "@types/supertest": "^6.0.3",
     "eslint": "^9.24.0",
+    "express": "^5.1.0",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0",
     "rimraf": "^6.0.1",
     "sinon": "^20.0.0",
+    "supertest": "^7.1.4",
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3"
   }

package/dist/src/RedisHealthService.d.ts

@@ -1,7 +0,0 @@
-import { HealthIndicatorResult } from '@nestjs/terminus';
-import { Redis } from 'ioredis';
-export declare class RedisHealthService {
-    private readonly redisClient;
-    constructor(redisClient: Redis);
-    checkRedisConnection(): Promise<HealthIndicatorResult>;
-}

package/dist/src/RedisHealthService.js

@@ -1,57 +0,0 @@
-"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 __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-var __param = (this && this.__param) || function (paramIndex, decorator) {
-    return function (target, key) { decorator(target, key, paramIndex); }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RedisHealthService = void 0;
-const common_1 = require("@nestjs/common");
-const ioredis_1 = require("ioredis");
-const ioredis_2 = require("@nestjs-modules/ioredis");
-let RedisHealthService = class RedisHealthService {
-    constructor(redisClient) {
-        this.redisClient = redisClient;
-    }
-    async checkRedisConnection() {
-        try {
-            const result = await this.redisClient.ping();
-            return {
-                redis: {
-                    status: 'up',
-                    result,
-                },
-            };
-        }
-        catch (error) {
-            if (error instanceof Error) {
-                return {
-                    redis: {
-                        status: 'down',
-                        message: error.message,
-                    },
-                };
-            }
-            return {
-                redis: {
-                    status: 'down',
-                    message: 'Could not connect to Redis.',
-                },
-            };
-        }
-    }
-};
-exports.RedisHealthService = RedisHealthService;
-exports.RedisHealthService = RedisHealthService = __decorate([
-    (0, common_1.Injectable)(),
-    __param(0, (0, ioredis_2.InjectRedis)()),
-    __metadata("design:paramtypes", [ioredis_1.Redis])
-], RedisHealthService);
-//# sourceMappingURL=RedisHealthService.js.map

package/dist/src/RedisHealthService.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"RedisHealthService.js","sourceRoot":"","sources":["../../src/RedisHealthService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAA4C;AAE5C,qCAAgC;AAChC,qDAAsD;AAS/C,IAAM,kBAAkB,GAAxB,MAAM,kBAAkB;IAC7B,YACkC,WAAkB;QAAlB,gBAAW,GAAX,WAAW,CAAO;IACjD,CAAC;IAEG,KAAK,CAAC,oBAAoB;QAC/B,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;YAE7C,OAAO;gBACL,KAAK,EAAE;oBACL,MAAM,EAAE,IAAI;oBACZ,MAAM;iBACP;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBAC3B,OAAO;oBACL,KAAK,EAAE;wBACL,MAAM,EAAE,MAAM;wBACd,OAAO,EAAE,KAAK,CAAC,OAAO;qBACvB;iBACF,CAAC;YACJ,CAAC;YACD,OAAO;gBACL,KAAK,EAAE;oBACL,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE,6BAA6B;iBACvC;aACF,CAAC;QACJ,CAAC;IACH,CAAC;CACF,CAAA;AAhCY,gDAAkB;6BAAlB,kBAAkB;IAD9B,IAAA,mBAAU,GAAE;IAGR,WAAA,IAAA,qBAAW,GAAE,CAAA;qCAA+B,eAAK;GAFzC,kBAAkB,CAgC9B"}

package/dist/src/constants.d.ts

@@ -1,4 +0,0 @@
-export declare enum HEALTH_STRATEGY_NAME {
-    HEALTHCHECK = "HealthcheckStrategy",
-    DEV = "DevStrategy"
-}

package/dist/src/constants.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HEALTH_STRATEGY_NAME = void 0;
-var HEALTH_STRATEGY_NAME;
-(function (HEALTH_STRATEGY_NAME) {
-    HEALTH_STRATEGY_NAME["HEALTHCHECK"] = "HealthcheckStrategy";
-    HEALTH_STRATEGY_NAME["DEV"] = "DevStrategy";
-})(HEALTH_STRATEGY_NAME || (exports.HEALTH_STRATEGY_NAME = HEALTH_STRATEGY_NAME = {}));
-//# sourceMappingURL=constants.js.map

package/dist/src/constants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAGA,IAAY,oBAqBX;AArBD,WAAY,oBAAoB;IAI9B,2DAAmC,CAAA;IAgBnC,2CAAmB,CAAA;AACrB,CAAC,EArBW,oBAAoB,oCAApB,oBAAoB,QAqB/B"}

package/dist/src/healthcheck.controller.d.ts

@@ -1,12 +0,0 @@
-import { HealthCheckService, TypeOrmHealthIndicator, HealthCheckResult, HttpHealthIndicator } from '@nestjs/terminus';
-import { ConfigServiceInterface } from './types/ConfigServiceInterface';
-import { RedisHealthService } from './RedisHealthService';
-export declare class HealthCheckController {
-    private config;
-    private health;
-    private db;
-    private http;
-    private redisHealth;
-    constructor(config: ConfigServiceInterface, health: HealthCheckService, db: TypeOrmHealthIndicator, http: HttpHealthIndicator, redisHealth: RedisHealthService);
-    getHealthCheck(): Promise<HealthCheckResult>;
-}

package/dist/src/healthcheck.controller.js

@@ -1,72 +0,0 @@
-"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 __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-var __param = (this && this.__param) || function (paramIndex, decorator) {
-    return function (target, key) { decorator(target, key, paramIndex); }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HealthCheckController = void 0;
-const common_1 = require("@nestjs/common");
-const swagger_1 = require("@nestjs/swagger");
-const terminus_1 = require("@nestjs/terminus");
-const RedisHealthService_1 = require("./RedisHealthService");
-const healthcheck_module_definition_1 = require("./healthcheck.module-definition");
-let HealthCheckController = class HealthCheckController {
-    constructor(config, health, db, http, redisHealth) {
-        this.config = config;
-        this.health = health;
-        this.db = db;
-        this.http = http;
-        this.redisHealth = redisHealth;
-    }
-    async getHealthCheck() {
-        const status = await this.health.check([
-            () => this.db.pingCheck('database'),
-            () => this.http.pingCheck('harvard-key', this.config.casCheckURL),
-            async () => this.redisHealth.checkRedisConnection(),
-            () => ({
-                buildVersion: {
-                    status: 'up',
-                    version: this.config.buildVersion,
-                },
-            }),
-        ]);
-        return status;
-    }
-};
-exports.HealthCheckController = HealthCheckController;
-__decorate([
-    (0, common_1.Get)('/'),
-    (0, swagger_1.ApiOperation)({
-        summary: 'While the server is active, return a 200 status code',
-    }),
-    (0, swagger_1.ApiOkResponse)({
-        description: 'A 200 response',
-        isArray: false,
-    }),
-    (0, terminus_1.HealthCheck)(),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", []),
-    __metadata("design:returntype", Promise)
-], HealthCheckController.prototype, "getHealthCheck", null);
-exports.HealthCheckController = HealthCheckController = __decorate([
-    (0, swagger_1.ApiTags)('Health Check'),
-    (0, common_1.Controller)('health-check'),
-    __param(0, (0, common_1.Inject)(healthcheck_module_definition_1.MODULE_OPTIONS_TOKEN)),
-    __param(1, (0, common_1.Inject)(terminus_1.HealthCheckService)),
-    __param(2, (0, common_1.Inject)(terminus_1.TypeOrmHealthIndicator)),
-    __param(3, (0, common_1.Inject)(terminus_1.HttpHealthIndicator)),
-    __param(4, (0, common_1.Inject)(RedisHealthService_1.RedisHealthService)),
-    __metadata("design:paramtypes", [Object, terminus_1.HealthCheckService,
-        terminus_1.TypeOrmHealthIndicator,
-        terminus_1.HttpHealthIndicator,
-        RedisHealthService_1.RedisHealthService])
-], HealthCheckController);
-//# sourceMappingURL=healthcheck.controller.js.map

package/dist/src/healthcheck.controller.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"healthcheck.controller.js","sourceRoot":"","sources":["../../src/healthcheck.controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAyD;AACzD,6CAAuE;AACvE,+CAAmI;AAEnI,6DAA0D;AAC1D,mFAAuE;AAIhE,IAAM,qBAAqB,GAA3B,MAAM,qBAAqB;IAEhC,YACwC,MAA8B,EAChC,MAA0B,EACtB,EAA0B,EAC7B,IAAyB,EAC1B,WAA+B;QAJ7B,WAAM,GAAN,MAAM,CAAwB;QAChC,WAAM,GAAN,MAAM,CAAoB;QACtB,OAAE,GAAF,EAAE,CAAwB;QAC7B,SAAI,GAAJ,IAAI,CAAqB;QAC1B,gBAAW,GAAX,WAAW,CAAoB;IAClE,CAAC;IAcS,AAAN,KAAK,CAAC,cAAc;QAEzB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YACrC,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC;YACnC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CACvB,aAAa,EACb,IAAI,CAAC,MAAM,CAAC,WAAW,CACxB;YACD,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE;YACnD,GAAG,EAAE,CAAC,CAAC;gBACL,YAAY,EAAE;oBACZ,MAAM,EAAE,IAAI;oBACZ,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,YAAY;iBAClC;aACF,CAAC;SACH,CACA,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;CACF,CAAA;AAzCY,sDAAqB;AAsBnB;IATZ,IAAA,YAAG,EAAC,GAAG,CAAC;IACR,IAAA,sBAAY,EAAC;QACZ,OAAO,EAAE,sDAAsD;KAChE,CAAC;IACD,IAAA,uBAAa,EAAC;QACb,WAAW,EAAE,gBAAgB;QAC7B,OAAO,EAAE,KAAK;KACf,CAAC;IACD,IAAA,sBAAW,GAAE;;;;2DAmBb;gCAxCU,qBAAqB;IAFjC,IAAA,iBAAO,EAAC,cAAc,CAAC;IACvB,IAAA,mBAAU,EAAC,cAAc,CAAC;IAItB,WAAA,IAAA,eAAM,EAAC,oDAAoB,CAAC,CAAA;IAC5B,WAAA,IAAA,eAAM,EAAC,6BAAkB,CAAC,CAAA;IAC1B,WAAA,IAAA,eAAM,EAAC,iCAAsB,CAAC,CAAA;IAC9B,WAAA,IAAA,eAAM,EAAC,8BAAmB,CAAC,CAAA;IAC3B,WAAA,IAAA,eAAM,EAAC,uCAAkB,CAAC,CAAA;6CAHiB,6BAAkB;QAClB,iCAAsB;QACvB,8BAAmB;QACb,uCAAkB;GAP1D,qBAAqB,CAyCjC"}

package/dist/src/healthcheck.module-definition.d.ts

@@ -1,2 +0,0 @@
-import { HealthcheckModuleOptions } from './types/healthcheckModuleOptions';
-export declare const ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<HealthcheckModuleOptions, "register", "create", {}>, MODULE_OPTIONS_TOKEN: string | symbol;

package/dist/src/healthcheck.module-definition.js

@@ -1,7 +0,0 @@
-"use strict";
-var _a;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MODULE_OPTIONS_TOKEN = exports.ConfigurableModuleClass = void 0;
-const common_1 = require("@nestjs/common");
-_a = new common_1.ConfigurableModuleBuilder().build(), exports.ConfigurableModuleClass = _a.ConfigurableModuleClass, exports.MODULE_OPTIONS_TOKEN = _a.MODULE_OPTIONS_TOKEN;
-//# sourceMappingURL=healthcheck.module-definition.js.map

package/dist/src/healthcheck.module-definition.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"healthcheck.module-definition.js","sourceRoot":"","sources":["../../src/healthcheck.module-definition.ts"],"names":[],"mappings":";;;;AAAA,2CAA2D;AAO9C,KAGT,IAAI,kCAAyB,EAA4B,CAAC,KAAK,EAAE,EAFnE,+BAAuB,+BACvB,4BAAoB,2BACgD"}

package/dist/src/healthcheck.module.d.ts

@@ -1,3 +0,0 @@
-import { ConfigurableModuleClass } from './healthcheck.module-definition';
-export declare class HealthcheckModule extends ConfigurableModuleClass {
-}

package/dist/src/healthcheck.module.js

@@ -1,31 +0,0 @@
-"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;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HealthcheckModule = void 0;
-const common_1 = require("@nestjs/common");
-const terminus_1 = require("@nestjs/terminus");
-const axios_1 = require("@nestjs/axios");
-const typeorm_1 = require("@nestjs/typeorm");
-const healthcheck_controller_1 = require("./healthcheck.controller");
-const RedisHealthService_1 = require("./RedisHealthService");
-const healthcheck_module_definition_1 = require("./healthcheck.module-definition");
-let HealthcheckModule = class HealthcheckModule extends healthcheck_module_definition_1.ConfigurableModuleClass {
-};
-exports.HealthcheckModule = HealthcheckModule;
-exports.HealthcheckModule = HealthcheckModule = __decorate([
-    (0, common_1.Module)({
-        imports: [
-            terminus_1.TerminusModule,
-            axios_1.HttpModule,
-            typeorm_1.TypeOrmModule.forFeature([]),
-        ],
-        controllers: [healthcheck_controller_1.HealthCheckController],
-        providers: [RedisHealthService_1.RedisHealthService],
-    })
-], HealthcheckModule);
-//# sourceMappingURL=healthcheck.module.js.map

package/dist/src/healthcheck.module.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"healthcheck.module.js","sourceRoot":"","sources":["../../src/healthcheck.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AACxC,+CAAkD;AAClD,yCAA2C;AAC3C,6CAAgD;AAChD,qEAAiE;AACjE,6DAA0D;AAC1D,mFAA0E;AAYnE,IAAM,iBAAiB,GAAvB,MAAM,iBAAkB,SAAQ,uDAAuB;CAAG,CAAA;AAApD,8CAAiB;4BAAjB,iBAAiB;IAV7B,IAAA,eAAM,EAAC;QACN,OAAO,EAAE;YACP,yBAAc;YACd,kBAAU;YACV,uBAAa,CAAC,UAAU,CAAC,EAAE,CAAC;SAC7B;QACD,WAAW,EAAE,CAAC,8CAAqB,CAAC;QACpC,SAAS,EAAE,CAAC,uCAAkB,CAAC;KAChC,CAAC;GAEW,iBAAiB,CAAmC"}

package/dist/src/index.d.ts

@@ -1,7 +0,0 @@
-export { HealthcheckModule } from './healthcheck.module';
-export * from './healthcheck.controller';
-export * from './RedisHealthService';
-export * from './types/ConfigServiceInterface';
-export * from './types/healthcheckModuleOptions';
-export * from './constants';
-export * from './healthcheck.module-definition';

package/dist/src/index.js

@@ -1,26 +0,0 @@
-"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 });
-exports.HealthcheckModule = void 0;
-var healthcheck_module_1 = require("./healthcheck.module");
-Object.defineProperty(exports, "HealthcheckModule", { enumerable: true, get: function () { return healthcheck_module_1.HealthcheckModule; } });
-__exportStar(require("./healthcheck.controller"), exports);
-__exportStar(require("./RedisHealthService"), exports);
-__exportStar(require("./types/ConfigServiceInterface"), exports);
-__exportStar(require("./types/healthcheckModuleOptions"), exports);
-__exportStar(require("./constants"), exports);
-__exportStar(require("./healthcheck.module-definition"), exports);
-//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2DAAyD;AAAhD,uHAAA,iBAAiB,OAAA;AAC1B,2DAAyC;AACzC,uDAAqC;AACrC,iEAA+C;AAC/C,mEAAiD;AACjD,8CAA4B;AAC5B,kEAAgD"}

package/dist/src/types/ConfigServiceInterface.d.ts

@@ -1,4 +0,0 @@
-export interface ConfigServiceInterface {
-    casCheckURL: string;
-    buildVersion: string;
-}

package/dist/src/types/ConfigServiceInterface.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=ConfigServiceInterface.js.map

package/dist/src/types/ConfigServiceInterface.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ConfigServiceInterface.js","sourceRoot":"","sources":["../../../src/types/ConfigServiceInterface.ts"],"names":[],"mappings":""}

package/dist/src/types/healthcheckModuleOptions.d.ts

@@ -1,9 +0,0 @@
-import { TypeOrmModuleOptions } from '@nestjs/typeorm';
-import { HEALTH_STRATEGY_NAME } from '../constants';
-export interface HealthcheckModuleOptions {
-    casCheckURL: string;
-    dbOptions: TypeOrmModuleOptions;
-    redisUrl: string;
-    buildVersion: string;
-    strategy: HEALTH_STRATEGY_NAME;
-}

package/dist/src/types/healthcheckModuleOptions.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-;
-//# sourceMappingURL=healthcheckModuleOptions.js.map

package/dist/src/types/healthcheckModuleOptions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"healthcheckModuleOptions.js","sourceRoot":"","sources":["../../../src/types/healthcheckModuleOptions.ts"],"names":[],"mappings":";;AAYC,CAAC"}