@deenruv/core 1.0.0

package/dist/health-check/health-check-registry.service.d.ts

@@ -0,0 +1,57 @@
+import { HealthIndicatorFunction } from "@nestjs/terminus";
+/**
+ * @description
+ * This service is used to register health indicator functions to be included in the
+ * health check. Health checks can be used by automated services such as Kubernetes
+ * to determine the state of applications it is running. They are also useful for
+ * administrators to get an overview of the health of all the parts of the
+ * Deenruv stack.
+ *
+ * It wraps the [Nestjs Terminus module](https://docs.nestjs.com/recipes/terminus),
+ * so see those docs for information on creating custom health checks.
+ *
+ * Plugins which rely on external services (web services, databases etc.) can make use of this
+ * service to add a check for that dependency to the Deenruv health check.
+ *
+ *
+ * Since v1.6.0, the preferred way to implement a custom health check is by creating a new {@link HealthCheckStrategy}
+ * and then passing it to the `systemOptions.healthChecks` array.
+ * See the {@link HealthCheckStrategy} docs for an example configuration.
+ *
+ * The alternative way to register a health check is by injecting this service directly into your
+ * plugin module. To use it in your plugin, you'll need to import the {@link PluginCommonModule}:
+ *
+ * @example
+ * ```ts
+ * import { HealthCheckRegistryService, PluginCommonModule, DeenruvPlugin } from '\@deenruv/core';
+ * import { TerminusModule } from '\@nestjs/terminus';
+ *
+ * \@DeenruvPlugin({
+ *   imports: [PluginCommonModule, TerminusModule],
+ * })
+ * export class MyPlugin {
+ *   constructor(
+ *     private registry: HealthCheckRegistryService
+ *     private httpIndicator: HttpHealthIndicator
+ *   ) {
+ *     registry.registerIndicatorFunction(
+ *       () => this.httpIndicator.pingCheck('deenruv-docs', 'https://deenruv.com/docs/'),
+ *     )
+ *   }
+ * }
+ * ```
+ *
+ * @docsCategory health-check
+ */
+export declare class HealthCheckRegistryService {
+    /** @internal */
+    get healthIndicatorFunctions(): HealthIndicatorFunction[];
+    private _healthIndicatorFunctions;
+    /**
+     * @description
+     * Registers one or more `HealthIndicatorFunctions` (see [Nestjs docs](https://docs.nestjs.com/recipes/terminus#setting-up-a-healthcheck))
+     * to be added to the health check endpoint.
+     * The indicator will also appear in the Admin UI's "system status" view.
+     */
+    registerIndicatorFunction(fn: HealthIndicatorFunction | HealthIndicatorFunction[]): void;
+}

package/dist/health-check/health-check-registry.service.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthCheckRegistryService = void 0;
+/**
+ * @description
+ * This service is used to register health indicator functions to be included in the
+ * health check. Health checks can be used by automated services such as Kubernetes
+ * to determine the state of applications it is running. They are also useful for
+ * administrators to get an overview of the health of all the parts of the
+ * Deenruv stack.
+ *
+ * It wraps the [Nestjs Terminus module](https://docs.nestjs.com/recipes/terminus),
+ * so see those docs for information on creating custom health checks.
+ *
+ * Plugins which rely on external services (web services, databases etc.) can make use of this
+ * service to add a check for that dependency to the Deenruv health check.
+ *
+ *
+ * Since v1.6.0, the preferred way to implement a custom health check is by creating a new {@link HealthCheckStrategy}
+ * and then passing it to the `systemOptions.healthChecks` array.
+ * See the {@link HealthCheckStrategy} docs for an example configuration.
+ *
+ * The alternative way to register a health check is by injecting this service directly into your
+ * plugin module. To use it in your plugin, you'll need to import the {@link PluginCommonModule}:
+ *
+ * @example
+ * ```ts
+ * import { HealthCheckRegistryService, PluginCommonModule, DeenruvPlugin } from '\@deenruv/core';
+ * import { TerminusModule } from '\@nestjs/terminus';
+ *
+ * \@DeenruvPlugin({
+ *   imports: [PluginCommonModule, TerminusModule],
+ * })
+ * export class MyPlugin {
+ *   constructor(
+ *     private registry: HealthCheckRegistryService
+ *     private httpIndicator: HttpHealthIndicator
+ *   ) {
+ *     registry.registerIndicatorFunction(
+ *       () => this.httpIndicator.pingCheck('deenruv-docs', 'https://deenruv.com/docs/'),
+ *     )
+ *   }
+ * }
+ * ```
+ *
+ * @docsCategory health-check
+ */
+class HealthCheckRegistryService {
+    constructor() {
+        this._healthIndicatorFunctions = [];
+    }
+    /** @internal */
+    get healthIndicatorFunctions() {
+        return this._healthIndicatorFunctions;
+    }
+    /**
+     * @description
+     * Registers one or more `HealthIndicatorFunctions` (see [Nestjs docs](https://docs.nestjs.com/recipes/terminus#setting-up-a-healthcheck))
+     * to be added to the health check endpoint.
+     * The indicator will also appear in the Admin UI's "system status" view.
+     */
+    registerIndicatorFunction(fn) {
+        const fnArray = Array.isArray(fn) ? fn : [fn];
+        this._healthIndicatorFunctions.push(...fnArray);
+    }
+}
+exports.HealthCheckRegistryService = HealthCheckRegistryService;
+//# sourceMappingURL=health-check-registry.service.js.map

package/dist/health-check/health-check-registry.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health-check-registry.service.js","sourceRoot":"","sources":["../../src/health-check/health-check-registry.service.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAa,0BAA0B;IAAvC;QAKU,8BAAyB,GAA8B,EAAE,CAAC;IAcpE,CAAC;IAlBC,gBAAgB;IAChB,IAAI,wBAAwB;QAC1B,OAAO,IAAI,CAAC,yBAAyB,CAAC;IACxC,CAAC;IAGD;;;;;OAKG;IACH,yBAAyB,CACvB,EAAuD;QAEvD,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;IAClD,CAAC;CACF;AAnBD,gEAmBC"}

package/dist/health-check/health-check.controller.d.ts

@@ -0,0 +1,8 @@
+import { HealthCheckService } from "@nestjs/terminus";
+import { HealthCheckRegistryService } from "./health-check-registry.service";
+export declare class HealthController {
+    private health;
+    private healthCheckRegistryService;
+    constructor(health: HealthCheckService, healthCheckRegistryService: HealthCheckRegistryService);
+    check(): Promise<import("@nestjs/terminus").HealthCheckResult>;
+}

package/dist/health-check/health-check.controller.js

@@ -0,0 +1,39 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthController = void 0;
+const common_1 = require("@nestjs/common");
+const terminus_1 = require("@nestjs/terminus");
+const constants_1 = require("./constants");
+const health_check_registry_service_1 = require("./health-check-registry.service");
+let HealthController = class HealthController {
+    constructor(health, healthCheckRegistryService) {
+        this.health = health;
+        this.healthCheckRegistryService = healthCheckRegistryService;
+    }
+    check() {
+        return this.health.check(this.healthCheckRegistryService.healthIndicatorFunctions);
+    }
+};
+exports.HealthController = HealthController;
+__decorate([
+    (0, common_1.Get)(),
+    (0, terminus_1.HealthCheck)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], HealthController.prototype, "check", null);
+exports.HealthController = HealthController = __decorate([
+    (0, common_1.Controller)(constants_1.HEALTH_CHECK_ROUTE),
+    __metadata("design:paramtypes", [terminus_1.HealthCheckService,
+        health_check_registry_service_1.HealthCheckRegistryService])
+], HealthController);
+//# sourceMappingURL=health-check.controller.js.map

package/dist/health-check/health-check.controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health-check.controller.js","sourceRoot":"","sources":["../../src/health-check/health-check.controller.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAiD;AACjD,+CAAmE;AAEnE,2CAAiD;AACjD,mFAA6E;AAGtE,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAC3B,YACU,MAA0B,EAC1B,0BAAsD;QADtD,WAAM,GAAN,MAAM,CAAoB;QAC1B,+BAA0B,GAA1B,0BAA0B,CAA4B;IAC7D,CAAC;IAIJ,KAAK;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,IAAI,CAAC,0BAA0B,CAAC,wBAAwB,CACzD,CAAC;IACJ,CAAC;CACF,CAAA;AAbY,4CAAgB;AAQ3B;IAFC,IAAA,YAAG,GAAE;IACL,IAAA,sBAAW,GAAE;;;;6CAKb;2BAZU,gBAAgB;IAD5B,IAAA,mBAAU,EAAC,8BAAkB,CAAC;qCAGX,6BAAkB;QACE,0DAA0B;GAHrD,gBAAgB,CAa5B"}

package/dist/health-check/health-check.module.d.ts

@@ -0,0 +1,7 @@
+import { ConfigService } from "../config/config.service";
+import { HealthCheckRegistryService } from "./health-check-registry.service";
+export declare class HealthCheckModule {
+    private configService;
+    private healthCheckRegistryService;
+    constructor(configService: ConfigService, healthCheckRegistryService: HealthCheckRegistryService);
+}

package/dist/health-check/health-check.module.js

@@ -0,0 +1,42 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthCheckModule = void 0;
+const common_1 = require("@nestjs/common");
+const terminus_1 = require("@nestjs/terminus");
+const config_module_1 = require("../config/config.module");
+const config_service_1 = require("../config/config.service");
+const job_queue_module_1 = require("../job-queue/job-queue.module");
+const health_check_registry_service_1 = require("./health-check-registry.service");
+const health_check_controller_1 = require("./health-check.controller");
+const http_health_check_strategy_1 = require("./http-health-check-strategy");
+let HealthCheckModule = class HealthCheckModule {
+    constructor(configService, healthCheckRegistryService) {
+        this.configService = configService;
+        this.healthCheckRegistryService = healthCheckRegistryService;
+        // Register all configured health checks
+        for (const strategy of this.configService.systemOptions.healthChecks) {
+            this.healthCheckRegistryService.registerIndicatorFunction(strategy.getHealthIndicator());
+        }
+    }
+};
+exports.HealthCheckModule = HealthCheckModule;
+exports.HealthCheckModule = HealthCheckModule = __decorate([
+    (0, common_1.Module)({
+        imports: [terminus_1.TerminusModule, config_module_1.ConfigModule, job_queue_module_1.JobQueueModule],
+        controllers: [health_check_controller_1.HealthController],
+        providers: [health_check_registry_service_1.HealthCheckRegistryService, http_health_check_strategy_1.CustomHttpHealthIndicator],
+        exports: [health_check_registry_service_1.HealthCheckRegistryService],
+    }),
+    __metadata("design:paramtypes", [config_service_1.ConfigService,
+        health_check_registry_service_1.HealthCheckRegistryService])
+], HealthCheckModule);
+//# sourceMappingURL=health-check.module.js.map

package/dist/health-check/health-check.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health-check.module.js","sourceRoot":"","sources":["../../src/health-check/health-check.module.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAwC;AACxC,+CAAkD;AAElD,2DAAuD;AACvD,6DAAyD;AAEzD,oEAA+D;AAE/D,mFAA6E;AAC7E,uEAA6D;AAC7D,6EAAyE;AAQlE,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;IAC5B,YACU,aAA4B,EAC5B,0BAAsD;QADtD,kBAAa,GAAb,aAAa,CAAe;QAC5B,+BAA0B,GAA1B,0BAA0B,CAA4B;QAE9D,wCAAwC;QACxC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC;YACrE,IAAI,CAAC,0BAA0B,CAAC,yBAAyB,CACvD,QAAQ,CAAC,kBAAkB,EAAE,CAC9B,CAAC;QACJ,CAAC;IACH,CAAC;CACF,CAAA;AAZY,8CAAiB;4BAAjB,iBAAiB;IAN7B,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,yBAAc,EAAE,4BAAY,EAAE,iCAAc,CAAC;QACvD,WAAW,EAAE,CAAC,0CAAgB,CAAC;QAC/B,SAAS,EAAE,CAAC,0DAA0B,EAAE,sDAAyB,CAAC;QAClE,OAAO,EAAE,CAAC,0DAA0B,CAAC;KACtC,CAAC;qCAGyB,8BAAa;QACA,0DAA0B;GAHrD,iBAAiB,CAY7B"}

package/dist/health-check/http-health-check-strategy.d.ts

@@ -0,0 +1,51 @@
+import { HealthIndicatorFunction, HealthIndicatorResult } from "@nestjs/terminus";
+import { HealthIndicator } from "@nestjs/terminus/dist/health-indicator/index";
+import { Injector } from "../common/injector";
+import { HealthCheckStrategy } from "../config/system/health-check-strategy";
+export interface HttpHealthCheckOptions {
+    key: string;
+    url: string;
+    timeout?: number;
+}
+/**
+ * @description
+ * A {@link HealthCheckStrategy} used to check health by pinging a url. Internally it uses
+ * the [NestJS HttpHealthIndicator](https://docs.nestjs.com/recipes/terminus#http-healthcheck).
+ *
+ * @example
+ * ```ts
+ * import { HttpHealthCheckStrategy, TypeORMHealthCheckStrategy } from '\@deenruv/core';
+ *
+ * export const config = {
+ *   // ...
+ *   systemOptions: {
+ *     healthChecks: [
+ *       new TypeORMHealthCheckStrategy(),
+ *       new HttpHealthCheckStrategy({ key: 'my-service', url: 'https://my-service.com' }),
+ *     ]
+ *   },
+ * };
+ * ```
+ *
+ * @docsCategory health-check
+ */
+export declare class HttpHealthCheckStrategy implements HealthCheckStrategy {
+    private options;
+    constructor(options: HttpHealthCheckOptions);
+    private injector;
+    init(injector: Injector): void;
+    getHealthIndicator(): HealthIndicatorFunction;
+}
+/**
+ * A much simplified version of the Terminus Modules' `HttpHealthIndicator` which has no
+ * dependency on the @nestjs/axios package.
+ */
+export declare class CustomHttpHealthIndicator extends HealthIndicator {
+    /**
+     * Prepares and throw a HealthCheckError
+     *
+     * @throws {HealthCheckError}
+     */
+    private generateHttpError;
+    pingCheck(key: string, url: string, timeout?: number): Promise<HealthIndicatorResult>;
+}

package/dist/health-check/http-health-check-strategy.js

@@ -0,0 +1,93 @@
+"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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomHttpHealthIndicator = exports.HttpHealthCheckStrategy = void 0;
+const common_1 = require("@nestjs/common");
+const terminus_1 = require("@nestjs/terminus");
+const index_1 = require("@nestjs/terminus/dist/health-indicator/index");
+const node_fetch_1 = __importDefault(require("node-fetch"));
+/**
+ * @description
+ * A {@link HealthCheckStrategy} used to check health by pinging a url. Internally it uses
+ * the [NestJS HttpHealthIndicator](https://docs.nestjs.com/recipes/terminus#http-healthcheck).
+ *
+ * @example
+ * ```ts
+ * import { HttpHealthCheckStrategy, TypeORMHealthCheckStrategy } from '\@deenruv/core';
+ *
+ * export const config = {
+ *   // ...
+ *   systemOptions: {
+ *     healthChecks: [
+ *       new TypeORMHealthCheckStrategy(),
+ *       new HttpHealthCheckStrategy({ key: 'my-service', url: 'https://my-service.com' }),
+ *     ]
+ *   },
+ * };
+ * ```
+ *
+ * @docsCategory health-check
+ */
+class HttpHealthCheckStrategy {
+    constructor(options) {
+        this.options = options;
+    }
+    init(injector) {
+        this.injector = injector;
+    }
+    getHealthIndicator() {
+        const { key, url, timeout } = this.options;
+        return async () => {
+            const indicator = await this.injector.resolve(CustomHttpHealthIndicator);
+            return indicator.pingCheck(key, url, timeout);
+        };
+    }
+}
+exports.HttpHealthCheckStrategy = HttpHealthCheckStrategy;
+/**
+ * A much simplified version of the Terminus Modules' `HttpHealthIndicator` which has no
+ * dependency on the @nestjs/axios package.
+ */
+let CustomHttpHealthIndicator = class CustomHttpHealthIndicator extends index_1.HealthIndicator {
+    /**
+     * Prepares and throw a HealthCheckError
+     *
+     * @throws {HealthCheckError}
+     */
+    generateHttpError(key, error) {
+        const response = {
+            message: error.message,
+        };
+        if (error.response) {
+            response.statusCode = error.response.status;
+            response.statusText = error.response.statusText;
+        }
+        throw new terminus_1.HealthCheckError(error.message, this.getStatus(key, false, response));
+    }
+    async pingCheck(key, url, timeout) {
+        let isHealthy = false;
+        try {
+            await (0, node_fetch_1.default)(url, { timeout });
+            isHealthy = true;
+        }
+        catch (err) {
+            this.generateHttpError(key, err);
+        }
+        return this.getStatus(key, isHealthy);
+    }
+};
+exports.CustomHttpHealthIndicator = CustomHttpHealthIndicator;
+exports.CustomHttpHealthIndicator = CustomHttpHealthIndicator = __decorate([
+    (0, common_1.Injectable)({
+        scope: common_1.Scope.TRANSIENT,
+    })
+], CustomHttpHealthIndicator);
+//# sourceMappingURL=http-health-check-strategy.js.map

package/dist/health-check/http-health-check-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-health-check-strategy.js","sourceRoot":"","sources":["../../src/health-check/http-health-check-strategy.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAmD;AACnD,+CAI0B;AAC1B,wEAA+E;AAC/E,4DAA+B;AAW/B;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,uBAAuB;IAClC,YAAoB,OAA+B;QAA/B,YAAO,GAAP,OAAO,CAAwB;IAAG,CAAC;IAGvD,IAAI,CAAC,QAAkB;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,kBAAkB;QAChB,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAC3C,OAAO,KAAK,IAAI,EAAE;YAChB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;YACzE,OAAO,SAAS,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;QAChD,CAAC,CAAC;IACJ,CAAC;CACF;AAfD,0DAeC;AAED;;;GAGG;AAII,IAAM,yBAAyB,GAA/B,MAAM,yBAA0B,SAAQ,uBAAe;IAC5D;;;;OAIG;IACK,iBAAiB,CAAC,GAAW,EAAE,KAAU;QAC/C,MAAM,QAAQ,GAA2B;YACvC,OAAO,EAAE,KAAK,CAAC,OAAO;SACvB,CAAC;QACF,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnB,QAAQ,CAAC,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;YAC5C,QAAQ,CAAC,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC;QAClD,CAAC;QACD,MAAM,IAAI,2BAAgB,CACxB,KAAK,CAAC,OAAO,EACb,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,CACrC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,SAAS,CACb,GAAW,EACX,GAAW,EACX,OAAgB;QAEhB,IAAI,SAAS,GAAG,KAAK,CAAC;QAEtB,IAAI,CAAC;YACH,MAAM,IAAA,oBAAK,EAAC,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;YAC9B,SAAS,GAAG,IAAI,CAAC;QACnB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACnC,CAAC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IACxC,CAAC;CACF,CAAA;AApCY,8DAAyB;oCAAzB,yBAAyB;IAHrC,IAAA,mBAAU,EAAC;QACV,KAAK,EAAE,cAAK,CAAC,SAAS;KACvB,CAAC;GACW,yBAAyB,CAoCrC"}

package/dist/health-check/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./constants";
+export * from "./health-check-registry.service";
+export * from "./typeorm-health-check-strategy";
+export * from "./http-health-check-strategy";

package/dist/health-check/index.js

@@ -0,0 +1,21 @@
+"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("./constants"), exports);
+__exportStar(require("./health-check-registry.service"), exports);
+__exportStar(require("./typeorm-health-check-strategy"), exports);
+__exportStar(require("./http-health-check-strategy"), exports);
+//# sourceMappingURL=index.js.map

package/dist/health-check/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/health-check/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,kEAAgD;AAChD,kEAAgD;AAChD,+DAA6C"}

package/dist/health-check/typeorm-health-check-strategy.d.ts

@@ -0,0 +1,38 @@
+import { HealthIndicatorFunction } from "@nestjs/terminus";
+import { Injector } from "../common/injector";
+import { HealthCheckStrategy } from "../config/system/health-check-strategy";
+export interface TypeORMHealthCheckOptions {
+    key?: string;
+    timeout?: number;
+}
+/**
+ * @description
+ * A {@link HealthCheckStrategy} used to check the health of the database. This health
+ * check is included by default, but can be customized by explicitly adding it to the
+ * `systemOptions.healthChecks` array:
+ *
+ * @example
+ * ```ts
+ * import { TypeORMHealthCheckStrategy } from '\@deenruv/core';
+ *
+ * export const config = {
+ *   // ...
+ *   systemOptions: {
+ *     healthChecks:[
+ *         // The default key is "database" and the default timeout is 1000ms
+ *         // Sometimes this is too short and leads to false negatives in the
+ *         // /health endpoint.
+ *         new TypeORMHealthCheckStrategy({ key: 'postgres-db', timeout: 5000 }),
+ *     ]
+ *   }
+ * }
+ * ```
+ *
+ * @docsCategory health-check
+ */
+export declare class TypeORMHealthCheckStrategy implements HealthCheckStrategy {
+    private options?;
+    constructor(options?: TypeORMHealthCheckOptions | undefined);
+    init(injector: Injector): Promise<void>;
+    getHealthIndicator(): HealthIndicatorFunction;
+}

package/dist/health-check/typeorm-health-check-strategy.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeORMHealthCheckStrategy = void 0;
+const terminus_1 = require("@nestjs/terminus");
+let indicator;
+/**
+ * @description
+ * A {@link HealthCheckStrategy} used to check the health of the database. This health
+ * check is included by default, but can be customized by explicitly adding it to the
+ * `systemOptions.healthChecks` array:
+ *
+ * @example
+ * ```ts
+ * import { TypeORMHealthCheckStrategy } from '\@deenruv/core';
+ *
+ * export const config = {
+ *   // ...
+ *   systemOptions: {
+ *     healthChecks:[
+ *         // The default key is "database" and the default timeout is 1000ms
+ *         // Sometimes this is too short and leads to false negatives in the
+ *         // /health endpoint.
+ *         new TypeORMHealthCheckStrategy({ key: 'postgres-db', timeout: 5000 }),
+ *     ]
+ *   }
+ * }
+ * ```
+ *
+ * @docsCategory health-check
+ */
+class TypeORMHealthCheckStrategy {
+    constructor(options) {
+        this.options = options;
+    }
+    async init(injector) {
+        indicator = await injector.resolve(terminus_1.TypeOrmHealthIndicator);
+    }
+    getHealthIndicator() {
+        var _a, _b, _c;
+        const key = ((_a = this.options) === null || _a === void 0 ? void 0 : _a.key) || "database";
+        const timeout = (_c = (_b = this.options) === null || _b === void 0 ? void 0 : _b.timeout) !== null && _c !== void 0 ? _c : 1000;
+        //@KAMIL help us
+        // return () => indicator.pingCheck(key, { timeout });
+        return () => Promise.resolve({ database: { status: "up" } });
+    }
+}
+exports.TypeORMHealthCheckStrategy = TypeORMHealthCheckStrategy;
+//# sourceMappingURL=typeorm-health-check-strategy.js.map

package/dist/health-check/typeorm-health-check-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeorm-health-check-strategy.js","sourceRoot":"","sources":["../../src/health-check/typeorm-health-check-strategy.ts"],"names":[],"mappings":";;;AAAA,+CAG0B;AAK1B,IAAI,SAAiC,CAAC;AAOtC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAa,0BAA0B;IACrC,YAAoB,OAAmC;QAAnC,YAAO,GAAP,OAAO,CAA4B;IAAG,CAAC;IAE3D,KAAK,CAAC,IAAI,CAAC,QAAkB;QAC3B,SAAS,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,iCAAsB,CAAC,CAAC;IAC7D,CAAC;IAED,kBAAkB;;QAChB,MAAM,GAAG,GAAG,CAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,GAAG,KAAI,UAAU,CAAC;QAC5C,MAAM,OAAO,GAAG,MAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,OAAO,mCAAI,IAAI,CAAC;QAC9C,gBAAgB;QAChB,sDAAsD;QACtD,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IAC/D,CAAC;CACF;AAdD,gEAcC"}

package/dist/i18n/i18n-error.d.ts

@@ -0,0 +1,26 @@
+import { GraphQLError } from "graphql";
+import { LogLevel } from "../config/logger/deenruv-logger";
+/**
+ * @description
+ * All errors thrown in the Deenruv server must use or extend this error class. This allows the
+ * error message to be translated before being served to the client.
+ *
+ * The error messages should be provided in the form of a string key which corresponds to
+ * a key defined in the `i18n/messages/<languageCode>.json` files.
+ *
+ * Note that this class should not be directly used in code, but should be extended by
+ * a more specific Error class.
+ *
+ * @docsCategory errors
+ */
+export declare abstract class I18nError extends GraphQLError {
+    message: string;
+    variables: {
+        [key: string]: string | number;
+    };
+    code?: string | undefined;
+    logLevel: LogLevel;
+    protected constructor(message: string, variables?: {
+        [key: string]: string | number;
+    }, code?: string | undefined, logLevel?: LogLevel);
+}

package/dist/i18n/i18n-error.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.I18nError = void 0;
+const graphql_1 = require("graphql");
+const deenruv_logger_1 = require("../config/logger/deenruv-logger");
+/**
+ * @description
+ * All errors thrown in the Deenruv server must use or extend this error class. This allows the
+ * error message to be translated before being served to the client.
+ *
+ * The error messages should be provided in the form of a string key which corresponds to
+ * a key defined in the `i18n/messages/<languageCode>.json` files.
+ *
+ * Note that this class should not be directly used in code, but should be extended by
+ * a more specific Error class.
+ *
+ * @docsCategory errors
+ */
+class I18nError extends graphql_1.GraphQLError {
+    constructor(message, variables = {}, code, logLevel = deenruv_logger_1.LogLevel.Warn) {
+        super(message, {
+            extensions: { code },
+        });
+        this.message = message;
+        this.variables = variables;
+        this.code = code;
+        this.logLevel = logLevel;
+    }
+}
+exports.I18nError = I18nError;
+//# sourceMappingURL=i18n-error.js.map

package/dist/i18n/i18n-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i18n-error.js","sourceRoot":"","sources":["../../src/i18n/i18n-error.ts"],"names":[],"mappings":";;;AAAA,qCAAuC;AAEvC,oEAA2D;AAE3D;;;;;;;;;;;;GAYG;AACH,MAAsB,SAAU,SAAQ,sBAAY;IAClD,YACS,OAAe,EACf,YAAgD,EAAE,EAClD,IAAa,EACb,WAAqB,yBAAQ,CAAC,IAAI;QAEzC,KAAK,CAAC,OAAO,EAAE;YACb,UAAU,EAAE,EAAE,IAAI,EAAE;SACrB,CAAC,CAAC;QAPI,YAAO,GAAP,OAAO,CAAQ;QACf,cAAS,GAAT,SAAS,CAAyC;QAClD,SAAI,GAAJ,IAAI,CAAS;QACb,aAAQ,GAAR,QAAQ,CAA0B;IAK3C,CAAC;CACF;AAXD,8BAWC"}

package/dist/i18n/i18n.module.d.ts

@@ -0,0 +1,2 @@
+export declare class I18nModule {
+}

package/dist/i18n/i18n.module.js

@@ -0,0 +1,23 @@
+"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.I18nModule = void 0;
+const common_1 = require("@nestjs/common");
+const config_module_1 = require("../config/config.module");
+const i18n_service_1 = require("./i18n.service");
+let I18nModule = class I18nModule {
+};
+exports.I18nModule = I18nModule;
+exports.I18nModule = I18nModule = __decorate([
+    (0, common_1.Module)({
+        imports: [config_module_1.ConfigModule],
+        providers: [i18n_service_1.I18nService],
+        exports: [i18n_service_1.I18nService],
+    })
+], I18nModule);
+//# sourceMappingURL=i18n.module.js.map

package/dist/i18n/i18n.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i18n.module.js","sourceRoot":"","sources":["../../src/i18n/i18n.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AAExC,2DAAuD;AAEvD,iDAA6C;AAOtC,IAAM,UAAU,GAAhB,MAAM,UAAU;CAAG,CAAA;AAAb,gCAAU;qBAAV,UAAU;IALtB,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,4BAAY,CAAC;QACvB,SAAS,EAAE,CAAC,0BAAW,CAAC;QACxB,OAAO,EAAE,CAAC,0BAAW,CAAC;KACvB,CAAC;GACW,UAAU,CAAG"}