@xnestjs/mongodb 1.6.4 → 1.7.0

package/cjs/index.js

@@ -3,5 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./constants.js"), exports);
 tslib_1.__exportStar(require("./get-mongodb-config.js"), exports);
+tslib_1.__exportStar(require("./mongodb.health.js"), exports);
 tslib_1.__exportStar(require("./mongodb.module.js"), exports);
 tslib_1.__exportStar(require("./types.js"), exports);

package/cjs/mongodb.health.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MongodbHealthIndicator = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const mongodb_1 = require("mongodb");
+/**
+ * The MongodbHealthIndicator contains health indicators
+ * which are used for health checks related to MongoDB
+ *
+ * @publicApi
+ * @module TerminusModule
+ */
+let MongodbHealthIndicator = class MongodbHealthIndicator {
+    constructor(moduleRef) {
+        this.moduleRef = moduleRef;
+    }
+    async pingCheck(key, options) {
+        const { HealthIndicatorService } = await Promise.resolve().then(() => tslib_1.__importStar(require('@nestjs/terminus')));
+        this.healthIndicatorService = this.healthIndicatorService || new HealthIndicatorService();
+        const indicator = this.healthIndicatorService.check(key);
+        let connection;
+        try {
+            connection =
+                options?.connection instanceof mongodb_1.MongoClient
+                    ? options?.connection
+                    : this.moduleRef.get(options?.connection || mongodb_1.MongoClient);
+            if (!connection)
+                return indicator.down('No connection provided');
+        }
+        catch (err) {
+            return indicator.down(err.message);
+        }
+        const timeout = options?.timeout || 5000;
+        try {
+            await connection.db().admin().ping({
+                timeoutMS: timeout,
+            });
+        }
+        catch (err) {
+            return indicator.down(err.message);
+        }
+        return indicator.up();
+    }
+};
+exports.MongodbHealthIndicator = MongodbHealthIndicator;
+exports.MongodbHealthIndicator = MongodbHealthIndicator = tslib_1.__decorate([
+    (0, common_1.Injectable)({ scope: common_1.Scope.TRANSIENT }),
+    tslib_1.__metadata("design:paramtypes", [core_1.ModuleRef])
+], MongodbHealthIndicator);

package/esm/index.js

@@ -1,4 +1,5 @@
 export * from './constants.js';
 export * from './get-mongodb-config.js';
+export * from './mongodb.health.js';
 export * from './mongodb.module.js';
 export * from './types.js';

package/esm/mongodb.health.js

@@ -0,0 +1,48 @@
+import { __decorate, __metadata } from "tslib";
+import { Injectable, Scope } from '@nestjs/common';
+import { ModuleRef } from '@nestjs/core';
+import { MongoClient } from 'mongodb';
+/**
+ * The MongodbHealthIndicator contains health indicators
+ * which are used for health checks related to MongoDB
+ *
+ * @publicApi
+ * @module TerminusModule
+ */
+let MongodbHealthIndicator = class MongodbHealthIndicator {
+    constructor(moduleRef) {
+        this.moduleRef = moduleRef;
+    }
+    async pingCheck(key, options) {
+        const { HealthIndicatorService } = await import('@nestjs/terminus');
+        this.healthIndicatorService = this.healthIndicatorService || new HealthIndicatorService();
+        const indicator = this.healthIndicatorService.check(key);
+        let connection;
+        try {
+            connection =
+                options?.connection instanceof MongoClient
+                    ? options?.connection
+                    : this.moduleRef.get(options?.connection || MongoClient);
+            if (!connection)
+                return indicator.down('No connection provided');
+        }
+        catch (err) {
+            return indicator.down(err.message);
+        }
+        const timeout = options?.timeout || 5000;
+        try {
+            await connection.db().admin().ping({
+                timeoutMS: timeout,
+            });
+        }
+        catch (err) {
+            return indicator.down(err.message);
+        }
+        return indicator.up();
+    }
+};
+MongodbHealthIndicator = __decorate([
+    Injectable({ scope: Scope.TRANSIENT }),
+    __metadata("design:paramtypes", [ModuleRef])
+], MongodbHealthIndicator);
+export { MongodbHealthIndicator };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xnestjs/mongodb",
-  "version": "1.6.4",
+  "version": "1.7.0",
   "description": "NestJS extension library for MongoDb",
   "author": "Panates",
   "license": "MIT",

package/types/index.d.cts

@@ -1,4 +1,5 @@
 export * from './constants.js';
 export * from './get-mongodb-config.js';
+export * from './mongodb.health.js';
 export * from './mongodb.module.js';
 export * from './types.js';

package/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from './constants.js';
 export * from './get-mongodb-config.js';
+export * from './mongodb.health.js';
 export * from './mongodb.module.js';
 export * from './types.js';

package/types/mongodb.health.d.ts

@@ -0,0 +1,27 @@
+import type { InjectionToken } from '@nestjs/common/interfaces/modules/injection-token.interface';
+import { ModuleRef } from '@nestjs/core';
+import type { HealthIndicatorService } from '@nestjs/terminus';
+import { MongoClient } from 'mongodb';
+export interface MongodbPingCheckSettings {
+    /**
+     * The MongoClient instance which the ping check should get executed
+     */
+    connection?: MongoClient | InjectionToken;
+    /**
+     * The amount of time the check should require in ms
+     */
+    timeout?: number;
+}
+/**
+ * The MongodbHealthIndicator contains health indicators
+ * which are used for health checks related to MongoDB
+ *
+ * @publicApi
+ * @module TerminusModule
+ */
+export declare class MongodbHealthIndicator {
+    private readonly moduleRef;
+    healthIndicatorService?: HealthIndicatorService;
+    constructor(moduleRef: ModuleRef);
+    pingCheck<Key extends string>(key: Key, options?: MongodbPingCheckSettings): Promise<import("@nestjs/terminus").HealthIndicatorResult<any, "down", any>>;
+}

package/types/types.d.ts

@@ -21,4 +21,15 @@ export interface MongodbModuleAsyncOptions extends BaseModuleOptions, Pick<Modul
     inject?: InjectionToken[];
     useFactory: (...args: any[]) => Promise<MongodbConnectionOptions> | MongodbConnectionOptions;
 }
+/**
+ * @publicApi
+ */
+export type HealthIndicatorStatus = 'up' | 'down';
+/**
+ * The result object of a health indicator
+ * @publicApi
+ */
+export type HealthIndicatorResult<Key extends string = string, Status extends HealthIndicatorStatus = HealthIndicatorStatus, OptionalData extends Record<string, any> = Record<string, any>> = Record<Key, {
+    status: Status;
+} & OptionalData>;
 export {};