@visulima/health-check 3.0.3 → 3.0.4

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+## @visulima/health-check [3.0.4](https://github.com/visulima/visulima/compare/@visulima/health-check@3.0.3...@visulima/health-check@3.0.4) (2025-11-12)
+
+### Bug Fixes
+
+* update package configurations and TypeScript definitions ([b59aa59](https://github.com/visulima/visulima/commit/b59aa59dac1508216b944f4b917fb4a7ab1f70a4))
+
+### Miscellaneous Chores
+
+* Add jsr file to all packages for release ([#565](https://github.com/visulima/visulima/issues/565)) ([ec91652](https://github.com/visulima/visulima/commit/ec91652b4e4112adf14ba152c1239a7703ba425a))
+
 ## @visulima/health-check [3.0.3](https://github.com/visulima/visulima/compare/@visulima/health-check@3.0.2...@visulima/health-check@3.0.3) (2025-11-07)
 
 ### Bug Fixes

package/dist/checks/dns-check.d.ts

@@ -0,0 +1,11 @@
+import type { Options } from "cacheable-lookup";
+import type { Checker } from "../types.d.ts";
+interface DnsOptions extends Options {
+    family?: "all" | 4 | 6;
+    hints?: number;
+}
+/**
+ * Register the `dns` checker to ensure that a domain is reachable.
+ */
+declare const dnsCheck: (host: string, expectedAddresses?: string[], options?: DnsOptions) => Checker;
+export default dnsCheck;

package/dist/checks/http-check.d.ts

@@ -0,0 +1,12 @@
+import type { Checker } from "../types.d.ts";
+/**
+ * Register the `http` checker to ensure http body and status is correct.
+ */
+declare const httpCheck: (host: RequestInfo | URL, options?: {
+    expected?: {
+        body?: string;
+        status?: number;
+    };
+    fetchOptions?: RequestInit;
+}) => Checker;
+export default httpCheck;

package/dist/checks/node-environment-check.d.ts

@@ -0,0 +1,7 @@
+import type { Checker } from "../types.d.ts";
+/**
+ * Register the `env` checker to ensure that `NODE_ENV` environment
+ * variable is defined.
+ */
+declare const nodeEnvironmentCheck: (expectedEnvironment?: string) => Checker;
+export default nodeEnvironmentCheck;

package/dist/checks/ping-check.d.ts

@@ -0,0 +1,7 @@
+import type { extendedPingOptions } from "pingman";
+import type { Checker } from "../types.d.ts";
+/**
+ * Register the `ping` checker to ensure that a domain is reachable.
+ */
+declare const pingCheck: (host: string, options?: extendedPingOptions) => Checker;
+export default pingCheck;

package/dist/handler/healthcheck.d.ts

@@ -0,0 +1,12 @@
+import type { IncomingMessage, ServerResponse } from "node:http";
+import type { HealthCheck, HealthReport } from "../types.d.ts";
+export interface HealthCheckApiPayload {
+    appName: string;
+    appVersion: string;
+    message: string;
+    reports: HealthReport;
+    status: "error" | "ok";
+    timestamp: string;
+}
+declare const _default: (healthCheck: HealthCheck, sendHeader?: boolean | undefined) => <Request extends IncomingMessage, Response extends ServerResponse>(_: Request, response: Response) => Promise<void>;
+export default _default;

package/dist/handler/readyhandler.d.ts

@@ -0,0 +1,4 @@
+import type { IncomingMessage, ServerResponse } from "node:http";
+import type { HealthCheck } from "../types.d.ts";
+declare const _default: <Request extends IncomingMessage, Response extends ServerResponse>(healthCheck: HealthCheck) => (_request: Request, response: Response) => Promise<void>;
+export default _default;

package/dist/healthcheck.d.ts

@@ -0,0 +1,26 @@
+import type { Checker, HealthCheck as HealthcheckInterface, HealthReport } from "./types.d.ts";
+declare class Healthcheck implements HealthcheckInterface {
+    /**
+     * A copy of registered checkers
+     */
+    private healthCheckers;
+    addChecker(service: string, checker: Checker): void;
+    /**
+     * Returns the health check reports. The health checks are performed when
+     * this method is invoked.
+     */
+    getReport(): Promise<{
+        healthy: boolean;
+        report: HealthReport;
+    }>;
+    isLive(): Promise<boolean>;
+    /**
+     * Returns an array of registered services names
+     */
+    get servicesList(): string[];
+    /**
+     * Invokes a given checker to collect the report metrics.
+     */
+    private invokeChecker;
+}
+export default Healthcheck;

package/dist/index.d.ts

@@ -1,61 +1,8 @@
-import { Options } from 'cacheable-lookup';
-import { extendedPingOptions } from 'pingman';
-import { IncomingMessage, ServerResponse } from 'node:http';
-
-interface HealthReportEntry {
-    displayName: string;
-    health: {
-        healthy: boolean;
-        message?: string;
-        timestamp: string;
-    };
-    meta?: any;
-}
-type Checker = () => Promise<HealthReportEntry>;
-type HealthReport = Record<string, HealthReportEntry>;
-interface HealthCheck {
-    addChecker: (service: string, checker: Checker) => void;
-    getReport: () => Promise<{
-        healthy: boolean;
-        report: HealthReport;
-    }>;
-    isLive: () => Promise<boolean>;
-    servicesList: string[];
-}
-
-interface DnsOptions extends Options {
-    family?: "all" | 4 | 6;
-    hints?: number;
-}
-declare const dnsCheck: (host: string, expectedAddresses?: string[], options?: DnsOptions) => Checker;
-
-declare const httpCheck: (host: RequestInfo | URL, options?: {
-    expected?: {
-        body?: string;
-        status?: number;
-    };
-    fetchOptions?: RequestInit;
-}) => Checker;
-
-declare const nodeEnvironmentCheck: (expectedEnvironment?: string) => Checker;
-
-declare const pingCheck: (host: string, options?: extendedPingOptions) => Checker;
-
-declare const _default$1: (healthCheck: HealthCheck, sendHeader?: boolean | undefined) => <Request extends IncomingMessage, Response extends ServerResponse>(_: Request, response: Response) => Promise<void>;
-
-declare const _default: <Request extends IncomingMessage, Response extends ServerResponse>(healthCheck: HealthCheck) => (_request: Request, response: Response) => Promise<void>;
-
-declare class Healthcheck implements HealthCheck {
-    private healthCheckers;
-    addChecker(service: string, checker: Checker): void;
-    getReport(): Promise<{
-        healthy: boolean;
-        report: HealthReport;
-    }>;
-    isLive(): Promise<boolean>;
-    get servicesList(): string[];
-    private invokeChecker;
-}
-
-export { Healthcheck as HealthCheck, dnsCheck, _default$1 as healthCheckHandler, _default as healthReadyHandler, httpCheck, nodeEnvironmentCheck as nodeEnvCheck, pingCheck };
-export type { Checker };
+export { default as dnsCheck } from "./checks/dns-check.d.ts";
+export { default as httpCheck } from "./checks/http-check.d.ts";
+export { default as nodeEnvCheck } from "./checks/node-environment-check.d.ts";
+export { default as pingCheck } from "./checks/ping-check.d.ts";
+export { default as healthCheckHandler } from "./handler/healthcheck.d.ts";
+export { default as healthReadyHandler } from "./handler/readyhandler.d.ts";
+export { default as HealthCheck } from "./healthcheck.d.ts";
+export type { Checker } from "./types.d.ts";

package/dist/types.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Shape of health report entry. Each checker must
+ * return an object with similar shape.
+ */
+export interface HealthReportEntry {
+    displayName: string;
+    health: {
+        healthy: boolean;
+        message?: string;
+        timestamp: string;
+    };
+    meta?: any;
+}
+export type Checker = () => Promise<HealthReportEntry>;
+/**
+ * The shape of entire report
+ */
+export type HealthReport = Record<string, HealthReportEntry>;
+/**
+ * Shape of health check contract
+ */
+export interface HealthCheck {
+    addChecker: (service: string, checker: Checker) => void;
+    getReport: () => Promise<{
+        healthy: boolean;
+        report: HealthReport;
+    }>;
+    isLive: () => Promise<boolean>;
+    servicesList: string[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visulima/health-check",
-  "version": "3.0.3",
+  "version": "3.0.4",
   "description": "A library built to provide support for defining service health for node services. It allows you to register async health checks for your dependencies and the service itself, provides a health endpoint that exposes their status, and health metrics.",
   "keywords": [
     "anolilab",