@tsed/terminus 8.0.0-alpha.5 → 8.0.0-alpha.6

package/package.json

@@ -1,18 +1,17 @@
 {
   "name": "@tsed/terminus",
   "description": "Adds graceful shutdown and Kubernetes readiness / liveness checks for any HTTP applications.",
-  "type": "commonjs",
-  "version": "8.0.0-alpha.5",
+  "type": "module",
+  "version": "8.0.0-alpha.6",
   "author": "Romain Lenzotti",
   "source": "./src/index.ts",
-  "main": "./lib/cjs/index.js",
+  "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
   "typings": "./lib/types/index.d.ts",
   "exports": {
     ".": {
       "types": "./lib/types/index.d.ts",
       "import": "./lib/esm/index.js",
-      "require": "./lib/cjs/index.js",
       "default": "./lib/cjs/index.js"
     }
   },
@@ -29,22 +28,22 @@
   },
   "devDependencies": {
     "@godaddy/terminus": "^4.12.1",
-    "@tsed/barrels": "8.0.0-alpha.5",
-    "@tsed/common": "8.0.0-alpha.5",
-    "@tsed/core": "8.0.0-alpha.5",
-    "@tsed/di": "8.0.0-alpha.5",
-    "@tsed/schema": "8.0.0-alpha.5",
-    "@tsed/typescript": "8.0.0-alpha.5",
+    "@tsed/barrels": "8.0.0-alpha.6",
+    "@tsed/common": "8.0.0-alpha.6",
+    "@tsed/core": "8.0.0-alpha.6",
+    "@tsed/di": "8.0.0-alpha.6",
+    "@tsed/schema": "8.0.0-alpha.6",
+    "@tsed/typescript": "8.0.0-alpha.6",
     "eslint": "^8.57.0",
     "typescript": "4.9.5",
     "vitest": "2.0.4"
   },
   "peerDependencies": {
     "@godaddy/terminus": "^4.7.1",
-    "@tsed/common": "8.0.0-alpha.5",
-    "@tsed/core": "8.0.0-alpha.5",
-    "@tsed/di": "8.0.0-alpha.5",
-    "@tsed/schema": "8.0.0-alpha.5"
+    "@tsed/common": "8.0.0-alpha.6",
+    "@tsed/core": "8.0.0-alpha.6",
+    "@tsed/di": "8.0.0-alpha.6",
+    "@tsed/schema": "8.0.0-alpha.6"
   },
   "peerDependenciesMeta": {
     "@godaddy/terminus": {

package/lib/cjs/TerminusModule.js

@@ -1,127 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TerminusModule = void 0;
-const tslib_1 = require("tslib");
-const terminus_1 = require("@godaddy/terminus");
-const di_1 = require("@tsed/di");
-const schema_1 = require("@tsed/schema");
-const http_1 = tslib_1.__importDefault(require("http"));
-const https_1 = tslib_1.__importDefault(require("https"));
-let TerminusModule = class TerminusModule {
-    $onInit() {
-        this.mount();
-    }
-    getConfiguration() {
-        const { path, ...props } = this.settings;
-        return {
-            logger: (event, error) => this.injector.logger.info({
-                event: event.toUpperCase(),
-                error_message: error.message
-            }),
-            healthChecks: this.getHealths(),
-            onSignal: this.createEmitter("$onSignal"),
-            onShutdown: this.createEmitter("$onShutdown"),
-            beforeShutdown: this.createEmitter("$beforeShutdown"),
-            onSendFailureDuringShutdown: this.createEmitter("$onSendFailureDuringShutdown"),
-            ...props
-        };
-    }
-    $logRoutes(routes) {
-        return Promise.resolve([
-            ...routes,
-            {
-                url: this.basePath,
-                method: "GET",
-                name: `TerminusModule.dispatch()`
-            },
-            ...this.getAll("health").map(({ provider, propertyKey, options }) => {
-                const path = this.getPath(provider, options.name);
-                return {
-                    method: "GET",
-                    name: `${provider.className}.${propertyKey}()`,
-                    url: path
-                };
-            })
-        ]);
-    }
-    mount() {
-        const terminusConfig = this.getConfiguration();
-        if (this.httpServer) {
-            (0, terminus_1.createTerminus)(this.httpServer, terminusConfig);
-        }
-        if (this.httpsServer) {
-            (0, terminus_1.createTerminus)(this.httpsServer, terminusConfig);
-        }
-    }
-    getAll(name) {
-        return this.injector.getProviders().flatMap((provider) => {
-            const metadata = provider.store.get(`terminus:${name}`);
-            if (metadata) {
-                return Object.entries(metadata).map(([propertyKey, options]) => {
-                    return {
-                        provider,
-                        propertyKey,
-                        options
-                    };
-                });
-            }
-            return [];
-        });
-    }
-    getHealths() {
-        const subHealths = this.getAll("health").reduce((healths, { provider, propertyKey, options: { name } }) => {
-            const instance = this.injector.get(provider.token);
-            const callback = async (...args) => {
-                const result = await instance[propertyKey](...args);
-                return { [name]: result };
-            };
-            let path = this.getPath(provider, name);
-            return {
-                ...healths,
-                [path]: callback
-            };
-        }, {});
-        const healths = {
-            ...subHealths,
-            [this.basePath]: (state) => {
-                const promises = Object.entries(subHealths).map(([path, callback]) => callback(state));
-                return Promise.all(promises);
-            }
-        };
-        return healths;
-    }
-    getPath(provider, name) {
-        let path = (0, schema_1.concatPath)(provider.path, name);
-        return path.includes("health") ? path : (0, schema_1.concatPath)(path, this.basePath);
-    }
-    createEmitter(name) {
-        return (...args) => {
-            return this.injector.emit(name, ...args);
-        };
-    }
-};
-tslib_1.__decorate([
-    (0, di_1.Constant)("terminus", {}),
-    tslib_1.__metadata("design:type", Object)
-], TerminusModule.prototype, "settings", void 0);
-tslib_1.__decorate([
-    (0, di_1.Constant)("terminus.path", "/health"),
-    tslib_1.__metadata("design:type", String)
-], TerminusModule.prototype, "basePath", void 0);
-tslib_1.__decorate([
-    (0, di_1.Inject)(),
-    tslib_1.__metadata("design:type", di_1.InjectorService)
-], TerminusModule.prototype, "injector", void 0);
-tslib_1.__decorate([
-    (0, di_1.Inject)(http_1.default.Server),
-    tslib_1.__metadata("design:type", Object)
-], TerminusModule.prototype, "httpServer", void 0);
-tslib_1.__decorate([
-    (0, di_1.Inject)(https_1.default.Server),
-    tslib_1.__metadata("design:type", Object)
-], TerminusModule.prototype, "httpsServer", void 0);
-TerminusModule = tslib_1.__decorate([
-    (0, di_1.Module)()
-], TerminusModule);
-exports.TerminusModule = TerminusModule;
-//# sourceMappingURL=TerminusModule.js.map

package/lib/cjs/TerminusModule.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"TerminusModule.js","sourceRoot":"","sources":["../../src/TerminusModule.ts"],"names":[],"mappings":";;;;AAAA,gDAAiD;AAEjD,iCAAqF;AACrF,yCAAwC;AACxC,wDAAwB;AACxB,0DAA0B;AAInB,IAAM,cAAc,GAApB,MAAM,cAAc;IAgBlB,OAAO;QACZ,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED,gBAAgB;QACd,MAAM,EAAC,IAAI,EAAE,GAAG,KAAK,EAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEvC,OAAO;YACL,MAAM,EAAE,CAAC,KAAa,EAAE,KAAU,EAAE,EAAE,CACpC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC;gBACxB,KAAK,EAAE,KAAK,CAAC,WAAW,EAAE;gBAC1B,aAAa,EAAE,KAAK,CAAC,OAAO;aAC7B,CAAC;YACJ,YAAY,EAAE,IAAI,CAAC,UAAU,EAAE;YAC/B,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YACzC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC;YAC7C,cAAc,EAAE,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC;YACrD,2BAA2B,EAAE,IAAI,CAAC,aAAa,CAAC,8BAA8B,CAAC;YAC/E,GAAG,KAAK;SACT,CAAC;IACJ,CAAC;IAED,UAAU,CAAC,MAA8B;QACvC,OAAO,OAAO,CAAC,OAAO,CAAC;YACrB,GAAG,MAAM;YACT;gBACE,GAAG,EAAE,IAAI,CAAC,QAAQ;gBAClB,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,2BAA2B;aAClC;YACD,GAAG,IAAI,CAAC,MAAM,CAAiB,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,EAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,EAAC,EAAE,EAAE;gBAChF,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;gBAElD,OAAO;oBACL,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,GAAG,QAAQ,CAAC,SAAS,IAAI,WAAW,IAAI;oBAC9C,GAAG,EAAE,IAAI;iBACH,CAAC;YACX,CAAC,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAEO,KAAK;QACX,MAAM,cAAc,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAE/C,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,IAAA,yBAAc,EAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;SACjD;QAED,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,IAAA,yBAAc,EAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;SAClD;IACH,CAAC;IAEO,MAAM,CACZ,IAAY;QAMZ,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YACvD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;YAExD,IAAI,QAAQ,EAAE;gBACZ,OAAO,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,OAAO,CAAiB,EAAE,EAAE;oBAC7E,OAAO;wBACL,QAAQ;wBACR,WAAW;wBACX,OAAO;qBACR,CAAC;gBACJ,CAAC,CAAC,CAAC;aACJ;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,UAAU;QAChB,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAiB,QAAQ,CAAC,CAAC,MAAM,CAC7D,CAAC,OAAO,EAAE,EAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,EAAE,EAAC,IAAI,EAAC,EAAC,EAAE,EAAE;YACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAM,QAAQ,CAAC,KAAK,CAAE,CAAC;YACzD,MAAM,QAAQ,GAAG,KAAK,EAAE,GAAG,IAAW,EAAE,EAAE;gBACxC,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;gBAEpD,OAAO,EAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAC,CAAC;YAC1B,CAAC,CAAC;YAEF,IAAI,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAExC,OAAO;gBACL,GAAG,OAAO;gBACV,CAAC,IAAI,CAAC,EAAE,QAAQ;aACjB,CAAC;QACJ,CAAC,EACD,EAAkD,CACnD,CAAC;QAEF,MAAM,OAAO,GAAwB;YACnC,GAAG,UAAU;YACb,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAU,EAAE,EAAE;gBAC9B,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;gBAEvF,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC/B,CAAC;SACF,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,OAAO,CAAC,QAAuB,EAAE,IAAY;QACnD,IAAI,IAAI,GAAG,IAAA,mBAAU,EAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,mBAAU,EAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC1E,CAAC;IAEO,aAAa,CAAC,IAAY;QAChC,OAAO,CAAC,GAAG,IAAW,EAAE,EAAE;YACxB,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;QAC3C,CAAC,CAAC;IACJ,CAAC;CACF,CAAA;AAtIC;IAAC,IAAA,aAAQ,EAAC,UAAU,EAAE,EAAE,CAAC;;gDACU;AAEnC;IAAC,IAAA,aAAQ,EAAC,eAAe,EAAE,SAAS,CAAC;;gDACZ;AAEzB;IAAC,IAAA,WAAM,GAAE;sCACS,oBAAe;gDAAC;AAElC;IAAC,IAAA,WAAM,EAAC,cAAI,CAAC,MAAM,CAAC;;kDACmB;AAEvC;IAAC,IAAA,WAAM,EAAC,eAAK,CAAC,MAAM,CAAC;;mDACoB;AAd9B,cAAc;IAD1B,IAAA,WAAM,GAAE;GACI,cAAc,CAuI1B;AAvIY,wCAAc"}

package/lib/cjs/decorators/health.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Health = void 0;
-const core_1 = require("@tsed/core");
-/**
- * Create a readiness / liveness checks.
- *
- * ```ts
- * import { Health } from "@tsed/terminus";
- *
- * @Controller("/mongo")
- * class MongoCtrl {
- *   @Health("/health")
- *   health() {
- *     // Here check the mongo health
- *     return Promise.resolve();
- *   }
- * }
- *
- * @param name
- * @decorator
- * @terminus
- */
-function Health(name) {
-    return (target, propertyKey) => {
-        core_1.Store.from(target).merge(`terminus:health`, {
-            [propertyKey]: { name }
-        });
-    };
-}
-exports.Health = Health;
-//# sourceMappingURL=health.js.map

package/lib/cjs/decorators/health.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"health.js","sourceRoot":"","sources":["../../../src/decorators/health.ts"],"names":[],"mappings":";;;AAAA,qCAAiC;AAEjC;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,MAAM,CAAC,IAAY;IACjC,OAAO,CAAW,MAAc,EAAE,WAAmB,EAAE,EAAE;QACvD,YAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,iBAAiB,EAAE;YAC1C,CAAC,WAAW,CAAC,EAAE,EAAC,IAAI,EAAC;SACtB,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAND,wBAMC"}

package/lib/cjs/index.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-tslib_1.__exportStar(require("./decorators/health.js"), exports);
-tslib_1.__exportStar(require("./interfaces/interfaces.js"), exports);
-tslib_1.__exportStar(require("./interfaces/TerminusSettings.js"), exports);
-tslib_1.__exportStar(require("./TerminusModule.js"), exports);
-//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,iEAAuC;AACvC,qEAA2C;AAC3C,2EAAiD;AACjD,8DAAoC"}

package/lib/cjs/interfaces/TerminusSettings.js

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

package/lib/cjs/interfaces/TerminusSettings.js.map

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

package/lib/cjs/interfaces/interfaces.js

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

package/lib/cjs/interfaces/interfaces.js.map

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

package/lib/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/lib/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

package/lib/types-esm/TerminusModule.d.ts

@@ -1,37 +0,0 @@
-import type { PlatformRouteDetails } from "@tsed/common";
-import { OnInit } from "@tsed/di";
-export declare class TerminusModule implements OnInit {
-    private settings;
-    private basePath;
-    private injector;
-    private httpServer;
-    private httpsServer;
-    $onInit(): void;
-    getConfiguration(): {
-        caseInsensitive?: boolean | undefined;
-        timeout?: number | undefined;
-        signal?: string | undefined;
-        signals?: string[] | undefined;
-        sendFailuresDuringShutdown?: boolean | undefined;
-        statusOk?: number | undefined;
-        statusOkResponse?: Record<string, unknown> | undefined;
-        statusError?: number | undefined;
-        statusErrorResponse?: Record<string, unknown> | undefined;
-        useExit0?: boolean | undefined;
-        logger: (event: string, error: any) => any;
-        headers?: {
-            [key: string]: string;
-        } | undefined;
-        healthChecks: Record<string, any>;
-        onSignal: (...args: any[]) => Promise<void>;
-        onShutdown: (...args: any[]) => Promise<void>;
-        beforeShutdown: (...args: any[]) => Promise<void>;
-        onSendFailureDuringShutdown: (...args: any[]) => Promise<void>;
-    };
-    $logRoutes(routes: PlatformRouteDetails[]): Promise<PlatformRouteDetails[]>;
-    private mount;
-    private getAll;
-    private getHealths;
-    private getPath;
-    private createEmitter;
-}

package/lib/types-esm/decorators/health.d.ts

@@ -1,20 +0,0 @@
-/**
- * Create a readiness / liveness checks.
- *
- * ```ts
- * import { Health } from "@tsed/terminus";
- *
- * @Controller("/mongo")
- * class MongoCtrl {
- *   @Health("/health")
- *   health() {
- *     // Here check the mongo health
- *     return Promise.resolve();
- *   }
- * }
- *
- * @param name
- * @decorator
- * @terminus
- */
-export declare function Health(name: string): MethodDecorator;

package/lib/types-esm/index.d.ts

@@ -1,7 +0,0 @@
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-export * from "./decorators/health.js";
-export * from "./interfaces/interfaces.js";
-export * from "./interfaces/TerminusSettings.js";
-export * from "./TerminusModule.js";

package/lib/types-esm/interfaces/TerminusSettings.d.ts

@@ -1,4 +0,0 @@
-import { TerminusOptions } from "@godaddy/terminus";
-export type TerminusSettings = Omit<TerminusOptions, "healthChecks" | "onSignal" | "onSendFailureDuringShutdown" | "onShutdown" | "beforeShutdown" | "onSigterm"> & {
-    path?: string;
-};

package/lib/types-esm/interfaces/interfaces.d.ts

@@ -1,8 +0,0 @@
-import { TerminusSettings } from "./TerminusSettings.js";
-declare global {
-    namespace TsED {
-        interface Configuration {
-            terminus: TerminusSettings;
-        }
-    }
-}