@terreno/api-health 0.31.0 → 56.0.0-beta.0

package/README.md

@@ -1,50 +1,5 @@
 # @terreno/api-health
 
-Health check TerrenoPlugin for `@terreno/api` — adds a configurable `GET /health` endpoint with optional custom checks.
+Health check plugin for `@terreno/api`. Adds a `/health` endpoint to your Express server with configurable checks.
 
-## Install
-
-```bash
-bun add @terreno/api-health @terreno/api
-```
-
-## Quick start
-
-```typescript
-import {TerrenoApp} from "@terreno/api";
-import {HealthApp} from "@terreno/api-health";
-import mongoose from "mongoose";
-import {User} from "./models/user";
-
-const healthApp = new HealthApp({
-  path: "/health",
-  check: async () => {
-    try {
-      await mongoose.connection.db!.admin().ping();
-      return {healthy: true, details: {database: "connected"}};
-    } catch {
-      return {healthy: false, details: {database: "disconnected"}};
-    }
-  },
-});
-
-new TerrenoApp({userModel: User}).register(healthApp).start();
-```
-
-Returns `200` with `{healthy: true, ...}` when healthy, `503` when `healthy: false`.
-
-## What's included
-
-- `HealthApp` — `TerrenoPlugin` registering a health endpoint
-- `HealthOptions` — `enabled`, `path`, and optional async `check` function
-- `HealthCheckResult` — `{healthy: boolean, details?: Record<string, unknown>}`
-- Default behavior: `GET /health` returns `{healthy: true}` when no custom check is provided
-- Supports load balancer probes, Kubernetes liveness/readiness, and database connectivity checks
-
-## Documentation
-
-Full API reference: [docs/reference/api-health.md](https://github.com/flourishhealth/terreno/blob/master/docs/reference/api-health.md)
-
-## License and Contributing
-
-Licensed under the [MIT License](https://github.com/flourishhealth/terreno/blob/master/LICENSE). See [CONTRIBUTING.md](https://github.com/flourishhealth/terreno/blob/master/CONTRIBUTING.md) for contribution guidelines.
+See the package source for usage and configuration details.

package/package.json

@@ -4,7 +4,7 @@
     "url": "https://github.com/FlourishHealth/terreno/issues"
   },
   "dependencies": {
-    "@terreno/api": "0.31.0",
+    "@terreno/api": "56.0.0-beta.0",
     "express": "^5.2.1"
   },
   "description": "Health check plugin for @terreno/api",
@@ -14,7 +14,7 @@
     "@types/express": "^5.0.6",
     "@types/supertest": "^7.2.0",
     "supertest": "^7.2.2",
-    "typescript": "~5.9.2"
+    "typescript": "~6.0.3"
   },
   "homepage": "https://github.com/FlourishHealth/terreno#readme",
   "keywords": [
@@ -23,7 +23,7 @@
     "express",
     "terreno"
   ],
-  "license": "MIT",
+  "license": "Apache-2.0",
   "main": "dist/index.js",
   "name": "@terreno/api-health",
   "publishConfig": {
@@ -44,5 +44,5 @@
     "test:coverage": "bun run ../scripts/check-coverage.ts"
   },
   "types": "dist/index.d.ts",
-  "version": "0.31.0"
+  "version": "56.0.0-beta.0"
 }

package/tsconfig.json

@@ -7,6 +7,7 @@
     "downlevelIteration": true,
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
+    "ignoreDeprecations": "6.0",
     "jsx": "react",
     "lib": ["es2017", "dom", "es2017.object"],
     "module": "commonjs",
@@ -18,6 +19,7 @@
     "noUnusedLocals": false,
     "noUnusedParameters": false,
     "outDir": "./dist",
+    "rootDir": "./src",
     "preserveConstEnums": true,
     "removeComments": false,
     "skipLibCheck": true,
@@ -26,6 +28,6 @@
     "strictNullChecks": true,
     "target": "es5"
   },
-  "exclude": ["node_modules"],
-  "include": ["src/**/*.ts*", "src/*.ts"]
+  "exclude": ["node_modules", "**/*.test.ts"],
+  "include": ["src/**/*.ts*", "src/*.ts", "src/**/*.d.ts"]
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2026 Flourish Health, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/dist/healthApp.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/healthApp.test.js

@@ -1,219 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
-    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var bun_test_1 = require("bun:test");
-var express_1 = __importDefault(require("express"));
-var supertest_1 = __importDefault(require("supertest"));
-var healthApp_1 = require("./healthApp");
-var createApp = function (healthApp) {
-    var app = (0, express_1.default)();
-    healthApp.register(app);
-    return app;
-};
-(0, bun_test_1.describe)("HealthApp", function () {
-    (0, bun_test_1.it)("returns healthy: true by default", function () { return __awaiter(void 0, void 0, void 0, function () {
-        var app, res;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    app = createApp(new healthApp_1.HealthApp());
-                    return [4 /*yield*/, (0, supertest_1.default)(app).get("/health").expect(200)];
-                case 1:
-                    res = _a.sent();
-                    (0, bun_test_1.expect)(res.body).toEqual({ healthy: true });
-                    return [2 /*return*/];
-            }
-        });
-    }); });
-    (0, bun_test_1.it)("uses custom path", function () { return __awaiter(void 0, void 0, void 0, function () {
-        var app, res;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    app = createApp(new healthApp_1.HealthApp({ path: "/status" }));
-                    return [4 /*yield*/, (0, supertest_1.default)(app).get("/health").expect(404)];
-                case 1:
-                    _a.sent();
-                    return [4 /*yield*/, (0, supertest_1.default)(app).get("/status").expect(200)];
-                case 2:
-                    res = _a.sent();
-                    (0, bun_test_1.expect)(res.body).toEqual({ healthy: true });
-                    return [2 /*return*/];
-            }
-        });
-    }); });
-    (0, bun_test_1.it)("does not register route when enabled is false", function () { return __awaiter(void 0, void 0, void 0, function () {
-        var app;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    app = createApp(new healthApp_1.HealthApp({ enabled: false }));
-                    return [4 /*yield*/, (0, supertest_1.default)(app).get("/health").expect(404)];
-                case 1:
-                    _a.sent();
-                    return [2 /*return*/];
-            }
-        });
-    }); });
-    (0, bun_test_1.it)("calls custom check function returning healthy", function () { return __awaiter(void 0, void 0, void 0, function () {
-        var app, res;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    app = createApp(new healthApp_1.HealthApp({
-                        check: function () { return ({
-                            details: { db: "connected" },
-                            healthy: true,
-                        }); },
-                    }));
-                    return [4 /*yield*/, (0, supertest_1.default)(app).get("/health").expect(200)];
-                case 1:
-                    res = _a.sent();
-                    (0, bun_test_1.expect)(res.body).toEqual({
-                        details: { db: "connected" },
-                        healthy: true,
-                    });
-                    return [2 /*return*/];
-            }
-        });
-    }); });
-    (0, bun_test_1.it)("returns 503 when check function returns unhealthy", function () { return __awaiter(void 0, void 0, void 0, function () {
-        var app, res;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    app = createApp(new healthApp_1.HealthApp({
-                        check: function () { return ({
-                            details: { db: "disconnected" },
-                            healthy: false,
-                        }); },
-                    }));
-                    return [4 /*yield*/, (0, supertest_1.default)(app).get("/health").expect(503)];
-                case 1:
-                    res = _a.sent();
-                    (0, bun_test_1.expect)(res.body.healthy).toBe(false);
-                    return [2 /*return*/];
-            }
-        });
-    }); });
-    (0, bun_test_1.it)("returns 503 when check function throws", function () { return __awaiter(void 0, void 0, void 0, function () {
-        var app, res;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    app = createApp(new healthApp_1.HealthApp({
-                        check: function () {
-                            throw new Error("DB connection failed");
-                        },
-                    }));
-                    return [4 /*yield*/, (0, supertest_1.default)(app).get("/health").expect(503)];
-                case 1:
-                    res = _a.sent();
-                    (0, bun_test_1.expect)(res.body).toEqual({
-                        details: { error: "DB connection failed" },
-                        healthy: false,
-                    });
-                    return [2 /*return*/];
-            }
-        });
-    }); });
-    (0, bun_test_1.it)("handles async check function", function () { return __awaiter(void 0, void 0, void 0, function () {
-        var app, res;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    app = createApp(new healthApp_1.HealthApp({
-                        check: function () { return __awaiter(void 0, void 0, void 0, function () {
-                            return __generator(this, function (_a) {
-                                return [2 /*return*/, ({
-                                        details: { uptime: 100 },
-                                        healthy: true,
-                                    })];
-                            });
-                        }); },
-                    }));
-                    return [4 /*yield*/, (0, supertest_1.default)(app).get("/health").expect(200)];
-                case 1:
-                    res = _a.sent();
-                    (0, bun_test_1.expect)(res.body.healthy).toBe(true);
-                    (0, bun_test_1.expect)(res.body.details.uptime).toBe(100);
-                    return [2 /*return*/];
-            }
-        });
-    }); });
-    (0, bun_test_1.it)("handles async check function that rejects", function () { return __awaiter(void 0, void 0, void 0, function () {
-        var app, res;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    app = createApp(new healthApp_1.HealthApp({
-                        check: function () { return __awaiter(void 0, void 0, void 0, function () {
-                            return __generator(this, function (_a) {
-                                throw new Error("Async failure");
-                            });
-                        }); },
-                    }));
-                    return [4 /*yield*/, (0, supertest_1.default)(app).get("/health").expect(503)];
-                case 1:
-                    res = _a.sent();
-                    (0, bun_test_1.expect)(res.body).toEqual({
-                        details: { error: "Async failure" },
-                        healthy: false,
-                    });
-                    return [2 /*return*/];
-            }
-        });
-    }); });
-    (0, bun_test_1.it)("defaults to empty options when none provided", function () { return __awaiter(void 0, void 0, void 0, function () {
-        var app, res;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    app = createApp(new healthApp_1.HealthApp());
-                    return [4 /*yield*/, (0, supertest_1.default)(app).get("/health").expect(200)];
-                case 1:
-                    res = _a.sent();
-                    (0, bun_test_1.expect)(res.body).toEqual({ healthy: true });
-                    return [2 /*return*/];
-            }
-        });
-    }); });
-});