@terreno/api-health 56.0.0-beta.0 → 57.0.0-beta.1

package/LICENSE

@@ -0,0 +1,21 @@
+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/README.md

@@ -1,5 +1,50 @@
 # @terreno/api-health
 
-Health check plugin for `@terreno/api`. Adds a `/health` endpoint to your Express server with configurable checks.
+Health check TerrenoPlugin for `@terreno/api` — adds a configurable `GET /health` endpoint with optional custom checks.
 
-See the package source for usage and configuration details.
+## 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.

package/package.json

@@ -4,7 +4,7 @@
     "url": "https://github.com/FlourishHealth/terreno/issues"
   },
   "dependencies": {
-    "@terreno/api": "56.0.0-beta.0",
+    "@terreno/api": "57.0.0-beta.1",
     "express": "^5.2.1"
   },
   "description": "Health check plugin for @terreno/api",
@@ -23,7 +23,7 @@
     "express",
     "terreno"
   ],
-  "license": "Apache-2.0",
+  "license": "MIT",
   "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": "56.0.0-beta.0"
+  "version": "57.0.0-beta.1"
 }