@rsdk/core 0.14.0

package/dist/health/exceptions/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("./health-check.exception"), exports);
+//# sourceMappingURL=index.js.map

package/dist/health/exceptions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/health/exceptions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC"}

package/dist/health/health.const.d.ts

@@ -0,0 +1,2 @@
+export declare const MODULE_OPTIONS = "HEALTH_MODULE_OPTIONS";
+export declare const HEALTH_SERVICE = "HEALTH_SERVICE_TOKEN";

package/dist/health/health.const.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HEALTH_SERVICE = exports.MODULE_OPTIONS = void 0;
+exports.MODULE_OPTIONS = 'HEALTH_MODULE_OPTIONS';
+exports.HEALTH_SERVICE = 'HEALTH_SERVICE_TOKEN';
+//# sourceMappingURL=health.const.js.map

package/dist/health/health.const.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.const.js","sourceRoot":"","sources":["../../src/health/health.const.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG,uBAAuB,CAAC;AACzC,QAAA,cAAc,GAAG,sBAAsB,CAAC"}

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

@@ -0,0 +1,5 @@
+import type { DynamicModule } from '@nestjs/common';
+import type { HealthModuleOptions } from './types';
+export declare class HealthModule {
+    static forRoot(options: HealthModuleOptions): DynamicModule;
+}

package/dist/health/health.module.js

@@ -0,0 +1,33 @@
+"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 HealthModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthModule = void 0;
+const common_1 = require("@nestjs/common");
+const health_const_1 = require("./health.const");
+const health_service_1 = require("./health.service");
+let HealthModule = HealthModule_1 = class HealthModule {
+    static forRoot(options) {
+        return {
+            controllers: [...options.controllers],
+            module: HealthModule_1,
+            providers: [
+                health_service_1.HealthChecksService,
+                {
+                    provide: health_const_1.MODULE_OPTIONS,
+                    useValue: options,
+                },
+            ],
+        };
+    }
+};
+HealthModule = HealthModule_1 = __decorate([
+    (0, common_1.Module)({})
+], HealthModule);
+exports.HealthModule = HealthModule;
+//# sourceMappingURL=health.module.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"health.module.js","sourceRoot":"","sources":["../../src/health/health.module.ts"],"names":[],"mappings":";;;;;;;;;;AACA,2CAAwC;AAExC,iDAAgD;AAChD,qDAAuD;AAIhD,IAAM,YAAY,oBAAlB,MAAM,YAAY;IACvB,MAAM,CAAC,OAAO,CAAC,OAA4B;QACzC,OAAO;YACL,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC;YACrC,MAAM,EAAE,cAAY;YACpB,SAAS,EAAE;gBACT,oCAAmB;gBACnB;oBACE,OAAO,EAAE,6BAAc;oBACvB,QAAQ,EAAE,OAAO;iBAClB;aACF;SACF,CAAC;IACJ,CAAC;CACF,CAAA;AAdY,YAAY;IADxB,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,YAAY,CAcxB;AAdY,oCAAY"}

package/dist/health/health.service.d.ts

@@ -0,0 +1,14 @@
+import { ModuleRef } from '@nestjs/core';
+import { ILogger } from '@rsdk/logging';
+import type { CheckSummary } from './types';
+export declare class HealthChecksService {
+    private readonly logger;
+    private readonly moduleRef;
+    private readonly indicators;
+    private readonly indicatorNames;
+    constructor(logger: ILogger, moduleRef: ModuleRef);
+    check(filter?: '*' | string): Promise<CheckSummary>;
+    onModuleInit(): Promise<void>;
+    private filterIndicators;
+    private resolve;
+}

package/dist/health/health.service.js

@@ -0,0 +1,118 @@
+"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); }
+};
+var HealthChecksService_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthChecksService = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const decorators_1 = require("@rsdk/decorators");
+const logging_1 = require("../logging");
+const exceptions_1 = require("./exceptions");
+const metadata_1 = require("./metadata");
+let HealthChecksService = HealthChecksService_1 = class HealthChecksService {
+    logger;
+    moduleRef;
+    indicators = { common: [] };
+    indicatorNames = new Map();
+    constructor(logger, moduleRef) {
+        this.logger = logger;
+        this.moduleRef = moduleRef;
+    }
+    async check(filter) {
+        this.logger.info('Checking health', { filter });
+        const indicators = this.filterIndicators(filter);
+        let success = true;
+        const summary = { details: {}, status: 'up' };
+        await Promise.all(indicators.map(async (indicator) => {
+            const name = this.indicatorNames.get(indicator);
+            if (!name) {
+                throw new Error(`Indicator [${indicator.constructor.name}] - name not found`);
+            }
+            try {
+                const result = await indicator.check();
+                if (result.isError) {
+                    success = false;
+                }
+                summary.details[name] = result;
+            }
+            catch (err) {
+                success = false;
+                summary.details[name] = err;
+            }
+        }));
+        if (!success) {
+            throw new exceptions_1.HealthCheckException(summary.details);
+        }
+        return summary;
+    }
+    async onModuleInit() {
+        this.logger.debug('Initializing indicators...');
+        for (const [ctor, { key, scope }] of metadata_1.IndicatorsRegistry.entries()) {
+            if (!this.indicators[scope]) {
+                this.indicators[scope] = [];
+            }
+            const [instance] = this.resolve([ctor]);
+            this.indicatorNames.set(instance, key);
+            this.indicators[scope].push(instance);
+        }
+        this.logger.info(`Indicators initialized!`);
+    }
+    filterIndicators(filter = '') {
+        switch (filter) {
+            /**
+             * This means readiness healthcheck which means that server itself is up,
+             * but doesn't guarantee that it is ready to serve.
+             */
+            case '':
+                return [];
+            /**
+             * This means - "perform all checks you have"
+             */
+            case '*':
+                return [...this.indicators.common];
+            /**
+             * Matching exact filter. If no specific checks
+             * found - common checks will be performed
+             */
+            default: {
+                const specific = this.indicators[filter];
+                if (!specific || specific.length === 0) {
+                    this.logger.warn(`Unsupported healthcheck filter: ${filter}`);
+                }
+                return [...this.indicators.common, ...(specific || [])];
+            }
+        }
+    }
+    resolve(indicators) {
+        return indicators.map((x) => {
+            if (typeof x !== 'function') {
+                return x;
+            }
+            return this.moduleRef.get(x, { strict: false });
+        });
+    }
+};
+__decorate([
+    (0, decorators_1.LogTime)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", Promise)
+], HealthChecksService.prototype, "check", null);
+HealthChecksService = HealthChecksService_1 = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, logging_1.InjectLogger)(HealthChecksService_1)),
+    __metadata("design:paramtypes", [Object, core_1.ModuleRef])
+], HealthChecksService);
+exports.HealthChecksService = HealthChecksService;
+//# sourceMappingURL=health.service.js.map

package/dist/health/health.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.service.js","sourceRoot":"","sources":["../../src/health/health.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAA4C;AAC5C,uCAAyC;AAEzC,iDAA2C;AAG3C,wCAA0C;AAE1C,6CAAoD;AACpD,yCAAgD;AAQzC,IAAM,mBAAmB,2BAAzB,MAAM,mBAAmB;IAKwB;IACnC;IALF,UAAU,GAAuB,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAChD,cAAc,GAAG,IAAI,GAAG,EAA2B,CAAC;IAErE,YACsD,MAAe,EAClD,SAAoB;QADe,WAAM,GAAN,MAAM,CAAS;QAClD,cAAS,GAAT,SAAS,CAAW;IACpC,CAAC;IAGE,AAAN,KAAK,CAAC,KAAK,CAAC,MAAqB;QAC/B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAEhD,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAEjD,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,MAAM,OAAO,GAAiB,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QAE5D,MAAM,OAAO,CAAC,GAAG,CACf,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;YACjC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAChD,IAAI,CAAC,IAAI,EAAE;gBACT,MAAM,IAAI,KAAK,CACb,cAAc,SAAS,CAAC,WAAW,CAAC,IAAI,oBAAoB,CAC7D,CAAC;aACH;YAED,IAAI;gBACF,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,KAAK,EAAE,CAAC;gBACvC,IAAI,MAAM,CAAC,OAAO,EAAE;oBAClB,OAAO,GAAG,KAAK,CAAC;iBACjB;gBAED,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;aAChC;YAAC,OAAO,GAAG,EAAE;gBACZ,OAAO,GAAG,KAAK,CAAC;gBAChB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,GAAU,CAAC;aACpC;QACH,CAAC,CAAC,CACH,CAAC;QAEF,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,iCAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SACjD;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAEhD,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,IAAI,6BAAkB,CAAC,OAAO,EAAE,EAAE;YACjE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;gBAC3B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;aAC7B;YAED,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YAExC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;YACvC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACvC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IAC9C,CAAC;IAEO,gBAAgB,CAAC,SAAuB,EAAE;QAChD,QAAQ,MAAM,EAAE;YACd;;;eAGG;YACH,KAAK,EAAE;gBACL,OAAO,EAAE,CAAC;YAEZ;;eAEG;YACH,KAAK,GAAG;gBACN,OAAO,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAErC;;;eAGG;YACH,OAAO,CAAC,CAAC;gBACP,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;gBAEzC,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;oBACtC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mCAAmC,MAAM,EAAE,CAAC,CAAC;iBAC/D;gBAED,OAAO,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,CAAC;aACzD;SACF;IACH,CAAC;IAEO,OAAO,CACb,UAAoD;QAEpD,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YAC1B,IAAI,OAAO,CAAC,KAAK,UAAU,EAAE;gBAC3B,OAAO,CAAC,CAAC;aACV;YAED,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAA;AAjGO;IADL,IAAA,oBAAO,GAAE;;;;gDAqCT;AA9CU,mBAAmB;IAD/B,IAAA,mBAAU,GAAE;IAMR,WAAA,IAAA,sBAAY,EAAC,qBAAmB,CAAC,CAAA;6CACN,gBAAS;GAN5B,mBAAmB,CA2G/B;AA3GY,kDAAmB"}

package/dist/health/helpers/check-result.class.d.ts

@@ -0,0 +1,37 @@
+export type CheckStatus = 'up' | 'down';
+export type CheckDetails = Record<string, unknown>;
+/**
+ * Check result is an outcome for a check. It is
+ * a little specialized version of classical Result
+ * abstraction with error and data
+ */
+export declare class CheckResult {
+    /**
+     * Check status
+     */
+    readonly status: CheckStatus;
+    /**
+     * @optional Custom attributes (key value) Will
+     * be returned to check caller or/and logged
+     */
+    readonly details?: CheckDetails;
+    private constructor();
+    /**
+     * Indicated that check was not successful
+     */
+    get isError(): boolean;
+    /**
+     * Creates successful CheckResult
+     *
+     * @param details Any custom attributes
+     * @returns CheckResult
+     */
+    static up(details: CheckDetails): CheckResult;
+    /**
+     * Creates failed CheckResult
+     *
+     * @param details Any custom attributes
+     * @returns CheckResult
+     */
+    static down(details: CheckDetails): CheckResult;
+}

package/dist/health/helpers/check-result.class.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckResult = void 0;
+/**
+ * Check result is an outcome for a check. It is
+ * a little specialized version of classical Result
+ * abstraction with error and data
+ */
+class CheckResult {
+    /**
+     * Check status
+     */
+    status;
+    /**
+     * @optional Custom attributes (key value) Will
+     * be returned to check caller or/and logged
+     */
+    details;
+    constructor(status, details) {
+        this.status = status;
+        this.details = details;
+    }
+    /**
+     * Indicated that check was not successful
+     */
+    get isError() {
+        return this.status === 'down';
+    }
+    /**
+     * Creates successful CheckResult
+     *
+     * @param details Any custom attributes
+     * @returns CheckResult
+     */
+    static up(details) {
+        return new CheckResult('up', details);
+    }
+    /**
+     * Creates failed CheckResult
+     *
+     * @param details Any custom attributes
+     * @returns CheckResult
+     */
+    static down(details) {
+        return new CheckResult('down', details);
+    }
+}
+exports.CheckResult = CheckResult;
+//# sourceMappingURL=check-result.class.js.map

package/dist/health/helpers/check-result.class.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"check-result.class.js","sourceRoot":"","sources":["../../../src/health/helpers/check-result.class.ts"],"names":[],"mappings":";;;AAGA;;;;GAIG;AACH,MAAa,WAAW;IACtB;;OAEG;IACM,MAAM,CAAc;IAE7B;;;OAGG;IACM,OAAO,CAAgB;IAEhC,YAAoB,MAAmB,EAAE,OAAqB;QAC5D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,OAAqB;QAC7B,OAAO,IAAI,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,OAAqB;QAC/B,OAAO,IAAI,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;CACF;AA3CD,kCA2CC"}

package/dist/health/helpers/index.d.ts

@@ -0,0 +1 @@
+export * from './check-result.class';

package/dist/health/helpers/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("./check-result.class"), exports);
+//# sourceMappingURL=index.js.map

package/dist/health/helpers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/health/helpers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC"}

package/dist/health/index.d.ts

@@ -0,0 +1,6 @@
+export * from './health.module';
+export * from './health.service';
+export * from './indicators.abstract';
+export * from './metadata/indicator.decorator';
+export * from './types';
+export * from './helpers';

package/dist/health/index.js

@@ -0,0 +1,23 @@
+"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("./health.module"), exports);
+__exportStar(require("./health.service"), exports);
+__exportStar(require("./indicators.abstract"), exports);
+__exportStar(require("./metadata/indicator.decorator"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./helpers"), exports);
+//# sourceMappingURL=index.js.map

package/dist/health/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/health/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,mDAAiC;AACjC,wDAAsC;AACtC,iEAA+C;AAC/C,0CAAwB;AACxB,4CAA0B"}

package/dist/health/indicators.abstract/fs-access.indicator.d.ts

@@ -0,0 +1,27 @@
+import { CheckResult } from '../helpers';
+import type { HealthIndicator } from '../types';
+export interface FileSystemCheckOptions {
+    /**
+     * Absolute path to file or directory
+     */
+    path: string;
+    /**
+     * Access mode (see fs.access docs on nodejs website)
+     */
+    mode?: number;
+}
+/**
+ * FileSystemIndicator checks if specified file or directory
+ * exists and is accessible to the application
+ *
+ * TODO: Need to be tested! Especially modes.
+ */
+export declare abstract class FileSystemIndicator implements HealthIndicator {
+    private path;
+    private mode;
+    constructor(options: FileSystemCheckOptions);
+    /**
+     * Проверяет, существует ли файл и есть ли к нему доступ
+     */
+    check(): Promise<CheckResult>;
+}

package/dist/health/indicators.abstract/fs-access.indicator.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileSystemIndicator = void 0;
+const fs_1 = require("fs");
+const helpers_1 = require("../helpers");
+/**
+ * FileSystemIndicator checks if specified file or directory
+ * exists and is accessible to the application
+ *
+ * TODO: Need to be tested! Especially modes.
+ */
+class FileSystemIndicator {
+    path;
+    mode;
+    constructor(options) {
+        this.path = options.path;
+        this.mode = options.mode;
+    }
+    /**
+     * Проверяет, существует ли файл и есть ли к нему доступ
+     */
+    check() {
+        return new Promise((resolve, reject) => {
+            (0, fs_1.access)(this.path, this.mode, (error) => {
+                if (!error) {
+                    resolve(helpers_1.CheckResult.up({ path: this.path }));
+                }
+                else {
+                    reject({ error });
+                }
+            });
+        });
+    }
+}
+exports.FileSystemIndicator = FileSystemIndicator;
+//# sourceMappingURL=fs-access.indicator.js.map

package/dist/health/indicators.abstract/fs-access.indicator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs-access.indicator.js","sourceRoot":"","sources":["../../../src/health/indicators.abstract/fs-access.indicator.ts"],"names":[],"mappings":";;;AAAA,2BAA4B;AAE5B,wCAAyC;AAezC;;;;;GAKG;AACH,MAAsB,mBAAmB;IAC/B,IAAI,CAAS;IACb,IAAI,CAAqB;IAEjC,YAAY,OAA+B;QACzC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,KAAK;QACH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAA,WAAM,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;gBACrC,IAAI,CAAC,KAAK,EAAE;oBACV,OAAO,CAAC,qBAAW,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;iBAC9C;qBAAM;oBACL,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;iBACnB;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAvBD,kDAuBC"}

package/dist/health/indicators.abstract/index.d.ts

@@ -0,0 +1,2 @@
+export * from './fs-access.indicator';
+export * from './ping.indicator';

package/dist/health/indicators.abstract/index.js

@@ -0,0 +1,19 @@
+"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("./fs-access.indicator"), exports);
+__exportStar(require("./ping.indicator"), exports);
+//# sourceMappingURL=index.js.map

package/dist/health/indicators.abstract/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/health/indicators.abstract/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,mDAAiC"}

package/dist/health/indicators.abstract/ping.indicator.d.ts

@@ -0,0 +1,21 @@
+import type { ILogger } from '@rsdk/logging';
+import type { CheckResult } from '../helpers';
+import type { HealthIndicator } from '../types';
+export interface PingCheckOptions {
+    /**
+     * URI of external resource
+     */
+    url: URL;
+}
+/**
+ * PingIndicator is meant to check access to some network
+ * resource.
+ *
+ * @attention NOT IMPLEMENTED
+ */
+export declare abstract class PingIndicator implements HealthIndicator {
+    protected logger: ILogger;
+    private readonly url;
+    constructor(logger: ILogger, options: PingCheckOptions);
+    check(): Promise<CheckResult>;
+}

package/dist/health/indicators.abstract/ping.indicator.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PingIndicator = void 0;
+const exceptions_1 = require("../../exceptions");
+/**
+ * PingIndicator is meant to check access to some network
+ * resource.
+ *
+ * @attention NOT IMPLEMENTED
+ */
+class PingIndicator {
+    logger;
+    url;
+    constructor(logger, options) {
+        this.logger = logger;
+        this.url = options.url;
+    }
+    async check() {
+        this.logger.info('Url to be checked', { url: this.url });
+        /**
+         * TODO: Implement this. How? Probably caller should
+         * specify strategy protocol to use
+         */
+        throw new exceptions_1.InternalException('Ping check is yet to be implemented!');
+    }
+}
+exports.PingIndicator = PingIndicator;
+//# sourceMappingURL=ping.indicator.js.map

package/dist/health/indicators.abstract/ping.indicator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ping.indicator.js","sourceRoot":"","sources":["../../../src/health/indicators.abstract/ping.indicator.ts"],"names":[],"mappings":";;;AAEA,iDAAqD;AAWrD;;;;;GAKG;AACH,MAAsB,aAAa;IAGX;IAFL,GAAG,CAAM;IAE1B,YAAsB,MAAe,EAAE,OAAyB;QAA1C,WAAM,GAAN,MAAM,CAAS;QACnC,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAEzD;;;WAGG;QACH,MAAM,IAAI,8BAAiB,CAAC,sCAAsC,CAAC,CAAC;IACtE,CAAC;CACF;AAhBD,sCAgBC"}

package/dist/health/metadata/index.d.ts

@@ -0,0 +1,2 @@
+export * from './indicator.decorator';
+export * from './indicators.registry';

package/dist/health/metadata/index.js

@@ -0,0 +1,19 @@
+"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("./indicator.decorator"), exports);
+__exportStar(require("./indicators.registry"), exports);
+//# sourceMappingURL=index.js.map

package/dist/health/metadata/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/health/metadata/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,wDAAsC"}

package/dist/health/metadata/indicator.decorator.d.ts

@@ -0,0 +1,5 @@
+export interface IndicatorOptions {
+    description?: string;
+    scope?: string;
+}
+export declare const Indicator: (key: string, options?: IndicatorOptions) => ClassDecorator;

package/dist/health/metadata/indicator.decorator.js

@@ -0,0 +1,16 @@
+"use strict";
+/* eslint-disable @typescript-eslint/ban-types */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Indicator = void 0;
+const indicators_registry_1 = require("./indicators.registry");
+const Indicator = (key, options = {}) => {
+    return function (target) {
+        indicators_registry_1.IndicatorsRegistry.register(target, {
+            key,
+            scope: 'common',
+            ...options,
+        });
+    };
+};
+exports.Indicator = Indicator;
+//# sourceMappingURL=indicator.decorator.js.map

package/dist/health/metadata/indicator.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indicator.decorator.js","sourceRoot":"","sources":["../../../src/health/metadata/indicator.decorator.ts"],"names":[],"mappings":";AAAA,iDAAiD;;;AAMjD,+DAA2D;AAOpD,MAAM,SAAS,GAAG,CACvB,GAAW,EACX,UAA4B,EAAE,EACd,EAAE;IAClB,OAAO,UAAU,MAAgB;QAC/B,wCAAkB,CAAC,QAAQ,CAAC,MAAsC,EAAE;YAClE,GAAG;YACH,KAAK,EAAE,QAAQ;YACf,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC,CAAC;AAXW,QAAA,SAAS,aAWpB"}

package/dist/health/metadata/indicators.registry.d.ts

@@ -0,0 +1,12 @@
+import type { Constructor } from '@rsdk/common';
+import type { HealthIndicator, IndicatorMetadata } from '../types';
+export declare class IndicatorsRegistry {
+    private static logger;
+    private static indicators;
+    static isRegistered(ctor: Constructor<HealthIndicator>): boolean;
+    static register(target: Constructor<HealthIndicator>, options: IndicatorMetadata): void;
+    static entries(): Iterable<[
+        Constructor<HealthIndicator>,
+        IndicatorMetadata
+    ]>;
+}

package/dist/health/metadata/indicators.registry.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IndicatorsRegistry = void 0;
+const logging_1 = require("@rsdk/logging");
+const exceptions_1 = require("../../exceptions");
+class IndicatorsRegistry {
+    static logger = logging_1.LoggerFactory.create('IndicatorsRegistry');
+    static indicators = new Map();
+    static isRegistered(ctor) {
+        return this.indicators.has(ctor);
+    }
+    static register(target, options) {
+        if (this.indicators.has(target)) {
+            throw new exceptions_1.DoubleInitException('Health indicator', target.name);
+        }
+        this.logger.info(`Registering indicator: ${target.name}`, {
+            indicator: target.name,
+        });
+        this.indicators.set(target, options);
+    }
+    static entries() {
+        return this.indicators.entries();
+    }
+}
+exports.IndicatorsRegistry = IndicatorsRegistry;
+//# sourceMappingURL=indicators.registry.js.map

package/dist/health/metadata/indicators.registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indicators.registry.js","sourceRoot":"","sources":["../../../src/health/metadata/indicators.registry.ts"],"names":[],"mappings":";;;AACA,2CAA8C;AAE9C,iDAAuD;AAGvD,MAAa,kBAAkB;IACrB,MAAM,CAAC,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAC3D,MAAM,CAAC,UAAU,GAAG,IAAI,GAAG,EAGhC,CAAC;IAEJ,MAAM,CAAC,YAAY,CAAC,IAAkC;QACpD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED,MAAM,CAAC,QAAQ,CACb,MAAoC,EACpC,OAA0B;QAE1B,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC/B,MAAM,IAAI,gCAAmB,CAAC,kBAAkB,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;SAChE;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,0BAA0B,MAAM,CAAC,IAAI,EAAE,EAAE;YACxD,SAAS,EAAE,MAAM,CAAC,IAAI;SACvB,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,CAAC,OAAO;QAGZ,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;IACnC,CAAC;;AA9BH,gDA+BC"}