@visulima/health-check 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+## @visulima/health-check 1.0.0 (2022-11-16)
+
+
+### Features
+
+* **health-check:** adding new health-check package ([#17](https://github.com/visulima/visulima/issues/17)) ([2e2a89f](https://github.com/visulima/visulima/commit/2e2a89fe85214237c9f55bf00d76b69de691ee3e))

package/README.md

@@ -0,0 +1,204 @@
+<div align="center">
+  <h3>Visulima health-check</h3>
+  <p>
+  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.
+
+It’s built on top of
+
+[pingman](https://github.com/dopecodez/pingman),
+[node:http](https://nodejs.org/api/http.html),
+[cacheable-lookup](https://github.com/szmarczak/cacheable-lookup),
+[node:process.env](https://nodejs.org/docs/latest/api/process.html#process_process_env)
+
+  </p>
+</div>
+
+<br />
+
+<div align="center">
+
+[![typescript-image]][typescript-url] [![npm-image]][npm-url] [![license-image]][license-url]
+
+</div>
+
+<div align="center">
+  <sub>Built with ❤︎ by <a href="https://twitter.com/_prisis_">Daniel Bannert</a></sub>
+</div>
+
+## Installation
+
+```sh
+npm install @visulima/health-check
+```
+
+```sh
+yarn add @visulima/health-check
+```
+
+```sh
+pnpm add @visulima/health-check
+```
+
+## Usecases for API health check endpoints
+
+Keeping the API health check endpoints generic allows  to use them for multiple purposes. In this section, we will review  of the everyday use cases of an API health check endpoint
+
+-   Container orchestrators and API load balancers can use API health check endpoint to find out about the process status
+-   Usage of memory, disk, and other server resources can be monitored via API health check endpoints
+-   Health checks can test APIs dependencies, such as databases and external service endpoints, to confirm availability and normal functioning.
+
+## Usage
+
+```ts
+import { healthCheckHandler, HealthCheck as HealthCheck, nodeEnvironmentCheck } from "@visulima/health-check";
+
+const HealthCheckService = new HealthCheck();
+
+HealthCheckService.addChecker("node-env", nodeEnvironmentCheck);
+
+export default healthCheckHandler(HealthCheckService); // returns a http handler
+```
+
+### API health check endpoint types
+
+There are at least three different types of API health check endpoints designed to serve specific purposes.
+
+-   _The readiness endpoint_, often available via `/health/ready`, returns the readiness state to accept incoming requests from the gateway or the upstream proxy. Readiness signals that the app is running normally but isn’t ready to receive requests  yet.
+
+-   _The liveness endpoint_, often available via `/health/live`, returns the liveness of a microservice. If the check does not return the expected response, it means that the process is unhealthy or dead and should be replaced as soon as possible.
+
+-   _The generic health check endpoint_, often available via `/health`, returns the status of the service and the dependencies.
+
+Consider the following example: an API that loads JSON-based data into memory to serve requests.
+
+The `/health/ready` continues to respond with `NOT_READY` signal while the API is loading the JSON file since the API cannot serve any request without the file in memory. Therefore, it may take  time for the API to process the entire file.
+
+The `/health/live` immediately signals `LIVE`, even though the app is not ready, to prevent the container orchestrator layer from restarting the app.
+
+> ### Consider protecting your health check endpoint
+>
+> Most ping endpoints are publicly available because they don’t provide much internal or sensitive information. On the other hand, API health check endpoints expose information about your service, so it’s a good idea to protect this endpoint. You only need to make sure that your API monitoring tool supports sending API access keys.
+
+### Built-in Checks
+
+The library comes with a set of built-in checks. Currently implemented checks are as follows:
+
+#### Node Environment Check
+
+This check verifies that the node environment is set to production.
+This check is useful for ensuring that the node environment is set to production in production environments or only that the NODE_ENV is set.
+
+```ts
+import { nodeEnvironmentCheck } from "@visulima/health-check";
+
+nodeEnvironmentCheck(); // check if NODE_ENV is set
+nodeEnvironmentCheck("production"); // check if NODE_ENV is set to production
+```
+
+#### HTTP built-in check
+
+The HTTP check allows you to trigger an HTTP request to one of your dependencies, and verify the response status, and optionally the content of the response body.
+
+```ts
+import { httpCheck } from "@visulima/health-check";
+
+httpCheck("https://example.com", {
+    fetchOptions: {
+        method: "GET",
+        headers: {
+            "Content-Type": "application/json",
+        },
+        // ... any other options you want to pass to node-fetch
+    },
+    expected: {
+        status: 200,
+        body: "OK",
+    },
+});
+```
+
+#### DNS built-in check(s)
+
+The DNS checks allow you to perform lookup to a given hostname / domain name / CNAME / etc, and validate that it resolves to at least the minimum number of required results.
+
+```ts
+import { dnsCheck } from "@visulima/health-check";
+
+dnsCheck("example.com", ["1.1.1.1"], {
+    family: "all",
+    // ... other options for cacheable-lookup
+});
+```
+
+#### Ping built-in check(s)
+
+The ping checks allow you to verifies that a resource is still alive and reachable. For example, you can use it as a DB ping check to verify that your DB is still alive and reachable.
+
+```ts
+import { pingCheck } from "@visulima/health-check";
+
+pingCheck("example.com", {
+    timeout: 1000,
+    // ... other options for pingman
+});
+```
+
+#### Custom Checks
+
+The library provides Check interface that you can implement to create your own custom checks.
+
+```ts
+type Checker = () => Promise<HealthReportEntry>;
+
+/**
+ * Shape of health report entry. Each checker must
+ * return an object with similar shape.
+ */
+type HealthReportEntry = {
+    displayName: string;
+    health: {
+        healthy: boolean;
+        message?: string;
+        timestamp: string;
+    };
+    meta?: any;
+};
+```
+
+#### Expose Health Endpoint
+
+The library provides an HTTP handler function for serving health stats in JSON format. You can register it using your favorite HTTP implementation like so:
+
+```ts
+import { handleHealthCheck } from "@visulima/health-check";
+
+export default handleHealthCheck();
+```
+
+## Supported Node.js Versions
+
+Libraries in this ecosystem make the best effort to track
+[Node.js’ release schedule](https://github.com/nodejs/release#release-schedule). Here’s [a
+post on why we think this is important](https://medium.com/the-node-js-collection/maintainers-should-consider-following-node-js-release-schedule-ab08ed4de71a).
+
+## Contributing
+
+If you would like to help take a look at the [list of issues](https://github.com/visulima/visulima/issues) and check our [Contributing](.github/CONTRIBUTING.md) guild.
+
+> **Note:** please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
+
+## Credits
+
+-   [Daniel Bannert](https://github.com/prisis)
+-   [All Contributors](https://github.com/visulima/visulima/graphs/contributors)
+
+## License
+
+The visulima health-check is open-sourced software licensed under the [MIT][license-url]
+
+[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
+[typescript-url]: "typescript"
+[license-image]: https://img.shields.io/npm/l/@visulima/health-check?color=blueviolet&style=for-the-badge
+[license-url]: LICENSE.md "license"
+[npm-image]: https://img.shields.io/npm/v/@visulima/health-check/alpha.svg?style=for-the-badge&logo=npm
+[npm-url]: https://www.npmjs.com/package/@visulima/health-check/v/alpha "npm"

package/dist/index.d.ts

@@ -0,0 +1,71 @@
+import { IncomingMessage, ServerResponse } from 'node:http';
+import { IPFamily, Options } from 'cacheable-lookup';
+import { extendedPingOptions } from 'pingman';
+
+type Checker = () => Promise<HealthReportEntry>;
+
+/**
+ * Shape of health report entry. Each checker must
+ * return an object with similar shape.
+ */
+type HealthReportEntry = {
+    displayName: string;
+    health: {
+        healthy: boolean;
+        message?: string;
+        timestamp: string;
+    };
+    meta?: any;
+};
+
+/**
+ * The shape of entire report
+ */
+type HealthReport = {
+    [service: string]: HealthReportEntry;
+};
+
+/**
+ * Shape of health check contract
+ */
+interface HealthCheck {
+    servicesList: string[];
+    addChecker(service: string, checker: Checker): void;
+    isLive(): Promise<boolean>;
+    getReport(): Promise<{ healthy: boolean; report: HealthReport }>;
+}
+
+declare const _default$1: (healthCheck: HealthCheck, sendHeader?: boolean | undefined) => <Request_1 extends IncomingMessage, Response_1 extends ServerResponse<IncomingMessage>>(_: Request_1, response: Response_1) => Promise<void>;
+
+declare const _default: <Request_1 extends IncomingMessage, Response_1 extends ServerResponse<IncomingMessage>>(healthCheck: HealthCheck) => (_request: Request_1, response: Response_1) => Promise<void>;
+
+declare class Healthcheck implements HealthCheck {
+    private healthCheckers;
+    get servicesList(): string[];
+    private invokeChecker;
+    addChecker(service: string, checker: Checker): void;
+    getReport(): Promise<{
+        healthy: boolean;
+        report: HealthReport;
+    }>;
+    isLive(): Promise<boolean>;
+}
+
+declare const dnsCheck: (host: string, expectedAddresses?: string[], options?: {
+    family?: IPFamily | "all";
+    hints?: number;
+} & Options) => Checker;
+
+declare const httpCheck: (host: RequestInfo | URL, options?: {
+    fetchOptions?: RequestInit;
+    expected?: {
+        status?: number;
+        body?: string;
+    };
+}) => Checker;
+
+declare const nodeEnvironmentCheck: (expectedEnv?: string) => Checker;
+
+declare const pingCheck: (host: string, options?: extendedPingOptions) => Checker;
+
+export { Checker, Healthcheck as HealthCheck, dnsCheck, _default$1 as healthCheckHandler, _default as healthReadyHandler, httpCheck, nodeEnvironmentCheck as nodeEnvCheck, pingCheck };

package/dist/index.js

@@ -0,0 +1,249 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }// src/handler/healthcheck.ts
+var _httpstatuscodes = require('http-status-codes');
+var healthcheck_default = (healthCheck, sendHeader = true) => async (_, response) => {
+  const { healthy, report } = await healthCheck.getReport();
+  const payload = {
+    status: healthy ? "ok" : "error",
+    message: healthy ? "Health check successful" : "Health check failed",
+    appName: _nullishCoalesce(process.env.APP_NAME, () => ( "unknown")),
+    appVersion: _nullishCoalesce(process.env.APP_VERSION, () => ( "unknown")),
+    timestamp: new Date().toISOString(),
+    reports: report
+  };
+  response.statusCode = healthy ? _httpstatuscodes.StatusCodes.OK : _httpstatuscodes.StatusCodes.SERVICE_UNAVAILABLE;
+  if (sendHeader) {
+    response.setHeader("Content-Type", "application/json");
+  }
+  response.end(JSON.stringify(payload));
+};
+
+// src/handler/readyhandler.ts
+
+var readyhandler_default = (healthCheck) => async (_request, response) => {
+  const { healthy } = await healthCheck.getReport();
+  response.statusCode = healthy ? _httpstatuscodes.StatusCodes.NO_CONTENT : _httpstatuscodes.StatusCodes.SERVICE_UNAVAILABLE;
+  response.end();
+};
+
+// src/healthcheck.ts
+var Healthcheck = class {
+  constructor() {
+    this.healthCheckers = {};
+  }
+  get servicesList() {
+    return Object.keys(this.healthCheckers);
+  }
+  async invokeChecker(service, reportSheet) {
+    const checker = this.healthCheckers[service];
+    let report;
+    try {
+      report = await checker();
+      report.displayName = report.displayName || service;
+    } catch (error) {
+      report = {
+        displayName: service,
+        health: { healthy: false, message: error.message, timestamp: new Date().toISOString() },
+        meta: { fatal: true }
+      };
+    }
+    reportSheet[service] = report;
+    return report.health.healthy;
+  }
+  addChecker(service, checker) {
+    this.healthCheckers[service] = checker;
+  }
+  async getReport() {
+    const report = {};
+    await Promise.all(Object.keys(this.healthCheckers).map((service) => this.invokeChecker(service, report)));
+    const unhealthyService = Object.keys(report).find((service) => !report[service].health.healthy);
+    return { healthy: !unhealthyService, report };
+  }
+  async isLive() {
+    const { healthy } = await this.getReport();
+    return healthy;
+  }
+};
+var healthcheck_default2 = Healthcheck;
+
+// src/checks/dns-check.ts
+var _cacheablelookup = require('cacheable-lookup'); var _cacheablelookup2 = _interopRequireDefault(_cacheablelookup);
+var DISPLAY_NAME = "DNS check for";
+var dnsCheck = (host, expectedAddresses, options) => async () => {
+  const { hints, family = "all", ...config } = options || {};
+  const cacheable = new (0, _cacheablelookup2.default)(config);
+  try {
+    const meta = await cacheable.lookupAsync(host.replace(/^https?:\/\//, ""), {
+      hints,
+      ...family === "all" ? { all: true } : { family }
+    });
+    if (Array.isArray(expectedAddresses) && !(expectedAddresses == null ? void 0 : expectedAddresses.includes(meta.address))) {
+      return {
+        displayName: `${DISPLAY_NAME} ${host}`,
+        health: {
+          healthy: false,
+          message: `${DISPLAY_NAME} ${host} returned address ${meta.address} instead of ${expectedAddresses.join(", ")}.`,
+          timestamp: new Date().toISOString()
+        },
+        meta: {
+          host,
+          addresses: meta
+        }
+      };
+    }
+    return {
+      displayName: `${DISPLAY_NAME} ${host}`,
+      health: {
+        healthy: true,
+        message: `${DISPLAY_NAME} ${host} were resolved.`,
+        timestamp: new Date().toISOString()
+      },
+      meta: {
+        host,
+        addresses: meta
+      }
+    };
+  } catch (error) {
+    return {
+      displayName: `${DISPLAY_NAME} ${host}`,
+      health: {
+        healthy: false,
+        message: error.message,
+        timestamp: new Date().toISOString()
+      },
+      meta: {
+        host
+      }
+    };
+  }
+};
+var dns_check_default = dnsCheck;
+
+// src/checks/http-check.ts
+var _assert = require('assert');
+var DISPLAY_NAME2 = "HTTP check for";
+var httpCheck = (host, options) => async () => {
+  var _a, _b, _c, _d, _e;
+  try {
+    const response = await fetch(host, (options == null ? void 0 : options.fetchOptions) || {});
+    if (typeof ((_a = options == null ? void 0 : options.expected) == null ? void 0 : _a.status) !== "undefined" && ((_b = options == null ? void 0 : options.expected) == null ? void 0 : _b.status) !== response.status) {
+      throw new Error(`${DISPLAY_NAME2} ${host} returned status ${response.status} instead of ${options == null ? void 0 : options.expected.status}`);
+    }
+    if (typeof ((_c = options == null ? void 0 : options.expected) == null ? void 0 : _c.body) !== "undefined") {
+      const textBody = await response.text();
+      try {
+        _assert.deepStrictEqual.call(void 0, textBody, options == null ? void 0 : options.expected.body);
+      } catch (e) {
+        throw new Error(`${DISPLAY_NAME2} ${host} returned body ${JSON.stringify(textBody)} instead of ${JSON.stringify(options == null ? void 0 : options.expected.body)}`);
+      }
+    }
+    return {
+      displayName: `${DISPLAY_NAME2} ${host}`,
+      health: {
+        healthy: true,
+        message: `${DISPLAY_NAME2} ${host} was successful.`,
+        timestamp: new Date().toISOString()
+      },
+      meta: {
+        host,
+        method: ((_d = options == null ? void 0 : options.fetchOptions) == null ? void 0 : _d.method) || "GET",
+        status: response.status
+      }
+    };
+  } catch (error) {
+    return {
+      displayName: `${DISPLAY_NAME2} ${host}`,
+      health: {
+        healthy: false,
+        message: error.message,
+        timestamp: new Date().toISOString()
+      },
+      meta: {
+        host,
+        method: ((_e = options == null ? void 0 : options.fetchOptions) == null ? void 0 : _e.method) || "GET"
+      }
+    };
+  }
+};
+var http_check_default = httpCheck;
+
+// src/checks/node-environment-check.ts
+var DISPLAY_NAME3 = "Node Environment Check";
+var nodeEnvironmentCheck = (expectedEnv) => async () => {
+  const environment = "development";
+  let errorMessage;
+  if (typeof environment !== "undefined" && typeof expectedEnv !== "undefined" && environment !== expectedEnv) {
+    errorMessage = `NODE_ENV environment variable is set to "${environment}" instead of "${expectedEnv}".`;
+  } else if (typeof environment === "undefined") {
+    errorMessage = ["Missing NODE_ENV environment variable.", "It can make some parts of the application misbehave"].join(" ");
+  }
+  if (typeof errorMessage !== "undefined") {
+    return {
+      displayName: DISPLAY_NAME3,
+      health: {
+        healthy: false,
+        message: errorMessage,
+        timestamp: new Date().toISOString()
+      }
+    };
+  }
+  return {
+    displayName: DISPLAY_NAME3,
+    health: {
+      healthy: true,
+      timestamp: new Date().toISOString()
+    },
+    meta: {
+      env: environment
+    }
+  };
+};
+var node_environment_check_default = nodeEnvironmentCheck;
+
+// src/checks/ping-check.ts
+var _pingman = require('pingman'); var _pingman2 = _interopRequireDefault(_pingman);
+var DISPLAY_NAME4 = "Ping check for";
+var pingCheck = (host, options) => async () => {
+  try {
+    const response = await _pingman2.default.call(void 0, host.replace(/^https?:\/\//, ""), options);
+    if (!response.alive) {
+      return {
+        displayName: `${DISPLAY_NAME4} ${host}`,
+        health: {
+          healthy: false,
+          message: `Ping failed for ${host}.`,
+          timestamp: new Date().toISOString()
+        },
+        meta: response
+      };
+    }
+    return {
+      displayName: `${DISPLAY_NAME4} ${host}`,
+      health: {
+        healthy: true,
+        message: `${DISPLAY_NAME4} ${host} was successful.`,
+        timestamp: new Date().toISOString()
+      },
+      meta: response
+    };
+  } catch (error) {
+    return {
+      displayName: `${DISPLAY_NAME4} ${host}`,
+      health: {
+        healthy: false,
+        message: error.message,
+        timestamp: new Date().toISOString()
+      }
+    };
+  }
+};
+var ping_check_default = pingCheck;
+
+
+
+
+
+
+
+
+exports.HealthCheck = healthcheck_default2; exports.dnsCheck = dns_check_default; exports.healthCheckHandler = healthcheck_default; exports.healthReadyHandler = readyhandler_default; exports.httpCheck = http_check_default; exports.nodeEnvCheck = node_environment_check_default; exports.pingCheck = ping_check_default;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/handler/healthcheck.ts","../src/handler/readyhandler.ts","../src/healthcheck.ts","../src/checks/dns-check.ts","../src/checks/http-check.ts","../src/checks/node-environment-check.ts","../src/checks/ping-check.ts"],"names":["StatusCodes","healthcheck_default","DISPLAY_NAME"],"mappings":";AAAA,SAAS,mBAAmB;AAK5B,IAAO,sBAAQ,CAAC,aAA0B,aAAkC,SACxE,OAAyE,GAAY,aAAuB;AACxG,QAAM,EAAE,SAAS,OAAO,IAAI,MAAM,YAAY,UAAU;AAExD,QAAM,UAAiC;AAAA,IACnC,QAAQ,UAAU,OAAO;AAAA,IACzB,SAAS,UAAU,4BAA4B;AAAA,IAC/C,SAAS,QAAQ,IAAI,YAAY;AAAA,IACjC,YAAY,QAAQ,IAAI,eAAe;AAAA,IACvC,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,IAClC,SAAS;AAAA,EACb;AAEA,WAAS,aAAa,UAAU,YAAY,KAAK,YAAY;AAE7D,MAAI,YAAY;AACZ,aAAS,UAAU,gBAAgB,kBAAkB;AAAA,EACzD;AAEA,WAAS,IAAI,KAAK,UAAU,OAAO,CAAC;AACxC;;;ACxBJ,SAAS,eAAAA,oBAAmB;AAI5B,IAAO,uBAAQ,CAAmE,gBAA6B,OAAO,UAAmB,aAAuB;AAC5J,QAAM,EAAE,QAAQ,IAAI,MAAM,YAAY,UAAU;AAEhD,WAAS,aAAa,UAAUA,aAAY,aAAaA,aAAY;AACrE,WAAS,IAAI;AACjB;;;ACNA,IAAM,cAAN,MAAkD;AAAA,EAAlD;AAII,SAAQ,iBAAiD,CAAC;AAAA;AAAA,EAK1D,IAAW,eAAyB;AAChC,WAAO,OAAO,KAAK,KAAK,cAAc;AAAA,EAC1C;AAAA,EAKA,MAAc,cAAc,SAAiB,aAA6C;AACtF,UAAM,UAAU,KAAK,eAAe;AAEpC,QAAI;AAEJ,QAAI;AACA,eAAS,MAAM,QAAQ;AAEvB,aAAO,cAAc,OAAO,eAAe;AAAA,IAC/C,SAAS,OAAP;AACE,eAAS;AAAA,QACL,aAAa;AAAA,QACb,QAAQ,EAAE,SAAS,OAAO,SAAS,MAAM,SAAS,WAAW,IAAI,KAAK,EAAE,YAAY,EAAE;AAAA,QACtF,MAAM,EAAE,OAAO,KAAK;AAAA,MACxB;AAAA,IACJ;AAGA,gBAAY,WAAW;AAEvB,WAAO,OAAO,OAAO;AAAA,EACzB;AAAA,EAEO,WAAW,SAAiB,SAAwB;AACvD,SAAK,eAAe,WAAW;AAAA,EACnC;AAAA,EAMA,MAAa,YAAiE;AAC1E,UAAM,SAAuB,CAAC;AAG9B,UAAM,QAAQ,IAAI,OAAO,KAAK,KAAK,cAAc,EAAE,IAAI,CAAC,YAAY,KAAK,cAAc,SAAS,MAAM,CAAC,CAAC;AAKxG,UAAM,mBAAmB,OAAO,KAAK,MAAM,EAAE,KAAK,CAAC,YAAY,CAAE,OAAO,SAA+B,OAAO,OAAO;AAErH,WAAO,EAAE,SAAS,CAAC,kBAAkB,OAAO;AAAA,EAChD;AAAA,EAEA,MAAa,SAA2B;AACpC,UAAM,EAAE,QAAQ,IAAI,MAAM,KAAK,UAAU;AAEzC,WAAO;AAAA,EACX;AACJ;AAEA,IAAOC,uBAAQ;;;ACvEf,OAAO,qBAAqB;AAI5B,IAAM,eAAe;AAKrB,IAAM,WAAW,CACb,MACA,mBACA,YAIU,YAAY;AACtB,QAAM,EAAE,OAAO,SAAS,UAAU,OAAO,IAAI,WAAW,CAAC;AAEzD,QAAM,YAAY,IAAI,gBAAgB,MAAM;AAE5C,MAAI;AACA,UAAM,OAAO,MAAM,UAAU,YAAY,KAAK,QAAQ,gBAAgB,EAAE,GAAG;AAAA,MACvE;AAAA,MACA,GAAI,WAAW,QAAQ,EAAE,KAAK,KAAK,IAAI,EAAE,OAA2B;AAAA,IACxE,CAAC;AAED,QAAI,MAAM,QAAQ,iBAAiB,KAAK,EAAC,uDAAmB,SAAS,KAAK,WAAU;AAChF,aAAO;AAAA,QACH,aAAa,GAAG,gBAAgB;AAAA,QAChC,QAAQ;AAAA,UACJ,SAAS;AAAA,UACT,SAAS,GAAG,gBAAgB,yBAAyB,KAAK,sBAAsB,kBAAkB,KAAK,IAAI;AAAA,UAC3G,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,QACtC;AAAA,QACA,MAAM;AAAA,UACF;AAAA,UACA,WAAW;AAAA,QACf;AAAA,MACJ;AAAA,IACJ;AAEA,WAAO;AAAA,MACH,aAAa,GAAG,gBAAgB;AAAA,MAChC,QAAQ;AAAA,QACJ,SAAS;AAAA,QACT,SAAS,GAAG,gBAAgB;AAAA,QAC5B,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,MACtC;AAAA,MACA,MAAM;AAAA,QACF;AAAA,QACA,WAAW;AAAA,MACf;AAAA,IACJ;AAAA,EACJ,SAAS,OAAP;AACE,WAAO;AAAA,MACH,aAAa,GAAG,gBAAgB;AAAA,MAChC,QAAQ;AAAA,QACJ,SAAS;AAAA,QACT,SAAS,MAAM;AAAA,QACf,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,MACtC;AAAA,MACA,MAAM;AAAA,QACF;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AACJ;AAEA,IAAO,oBAAQ;;;ACtEf,SAAS,uBAAuB;AAIhC,IAAMC,gBAAe;AAKrB,IAAM,YACF,CAAC,MAAyB,YAI1B,YAAY;AAdhB;AAeQ,MAAI;AAEA,UAAM,WAAW,MAAM,MAAM,OAAM,mCAAS,iBAAgB,CAAC,CAAC;AAE9D,QAAI,SAAO,wCAAS,aAAT,mBAAmB,YAAW,iBAAe,wCAAS,aAAT,mBAAmB,YAAW,SAAS,QAAQ;AACnG,YAAM,IAAI,MAAM,GAAGA,iBAAgB,wBAAwB,SAAS,qBAAqB,mCAAS,SAAS,QAAQ;AAAA,IACvH;AAEA,QAAI,SAAO,wCAAS,aAAT,mBAAmB,UAAS,aAAa;AAChD,YAAM,WAAW,MAAM,SAAS,KAAK;AAErC,UAAI;AACA,wBAAgB,UAAU,mCAAS,SAAS,IAAI;AAAA,MACpD,QAAE;AACE,cAAM,IAAI,MAAM,GAAGA,iBAAgB,sBAAsB,KAAK,UAAU,QAAQ,gBAAgB,KAAK,UAAU,mCAAS,SAAS,IAAI,GAAG;AAAA,MAC5I;AAAA,IACJ;AAEA,WAAO;AAAA,MACH,aAAa,GAAGA,iBAAgB;AAAA,MAChC,QAAQ;AAAA,QACJ,SAAS;AAAA,QACT,SAAS,GAAGA,iBAAgB;AAAA,QAC5B,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,MACtC;AAAA,MACA,MAAM;AAAA,QACF;AAAA,QACA,UAAQ,wCAAS,iBAAT,mBAAuB,WAAU;AAAA,QACzC,QAAQ,SAAS;AAAA,MACrB;AAAA,IACJ;AAAA,EACJ,SAAS,OAAP;AACE,WAAO;AAAA,MACH,aAAa,GAAGA,iBAAgB;AAAA,MAChC,QAAQ;AAAA,QACJ,SAAS;AAAA,QACT,SAAS,MAAM;AAAA,QACf,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,MACtC;AAAA,MACA,MAAM;AAAA,QACF;AAAA,QACA,UAAQ,wCAAS,iBAAT,mBAAuB,WAAU;AAAA,MAC7C;AAAA,IACJ;AAAA,EACJ;AACJ;AAEJ,IAAO,qBAAQ;;;AC5Df,IAAMA,gBAAe;AAMrB,IAAM,uBAAuB,CAAC,gBAAkC,YAAY;AACxE,QAAM,cAAc;AAEpB,MAAI;AAEJ,MAAI,OAAO,gBAAgB,eAAe,OAAO,gBAAgB,eAAe,gBAAgB,aAAa;AACzG,mBAAe,4CAA4C,4BAA4B;AAAA,EAC3F,WAAW,OAAO,gBAAgB,aAAa;AAC3C,mBAAe,CAAC,0CAA0C,qDAAqD,EAAE,KAAK,GAAG;AAAA,EAC7H;AAEA,MAAI,OAAO,iBAAiB,aAAa;AACrC,WAAO;AAAA,MACH,aAAaA;AAAA,MACb,QAAQ;AAAA,QACJ,SAAS;AAAA,QACT,SAAS;AAAA,QACT,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,MACtC;AAAA,IACJ;AAAA,EACJ;AAEA,SAAO;AAAA,IACH,aAAaA;AAAA,IACb,QAAQ;AAAA,MACJ,SAAS;AAAA,MACT,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,IACtC;AAAA,IACA,MAAM;AAAA,MACF,KAAK;AAAA,IACT;AAAA,EACJ;AACJ;AAEA,IAAO,iCAAQ;;;ACzCf,OAAO,UAAU;AAIjB,IAAMA,gBAAe;AAKrB,IAAM,YAAY,CAAC,MAAc,YAA2C,YAAY;AACpF,MAAI;AACA,UAAM,WAAW,MAAM,KAAK,KAAK,QAAQ,gBAAgB,EAAE,GAAG,OAAO;AAErE,QAAI,CAAC,SAAS,OAAO;AACjB,aAAO;AAAA,QACH,aAAa,GAAGA,iBAAgB;AAAA,QAChC,QAAQ;AAAA,UACJ,SAAS;AAAA,UACT,SAAS,mBAAmB;AAAA,UAC5B,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,QACtC;AAAA,QACA,MAAM;AAAA,MACV;AAAA,IACJ;AAEA,WAAO;AAAA,MACH,aAAa,GAAGA,iBAAgB;AAAA,MAChC,QAAQ;AAAA,QACJ,SAAS;AAAA,QACT,SAAS,GAAGA,iBAAgB;AAAA,QAC5B,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,MACtC;AAAA,MACA,MAAM;AAAA,IACV;AAAA,EACJ,SAAS,OAAP;AACE,WAAO;AAAA,MACH,aAAa,GAAGA,iBAAgB;AAAA,MAChC,QAAQ;AAAA,QACJ,SAAS;AAAA,QACT,SAAS,MAAM;AAAA,QACf,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,MACtC;AAAA,IACJ;AAAA,EACJ;AACJ;AAEA,IAAO,qBAAQ","sourcesContent":["import { StatusCodes } from \"http-status-codes\";\nimport type { IncomingMessage, ServerResponse } from \"node:http\";\n\nimport type { HealthCheck, HealthReport } from \"../types\";\n\nexport default (healthCheck: HealthCheck, sendHeader: boolean | undefined = true) =>\n    async <Request extends IncomingMessage, Response extends ServerResponse>(_: Request, response: Response) => {\n        const { healthy, report } = await healthCheck.getReport();\n\n        const payload: HealthCheckApiPayload = {\n            status: healthy ? \"ok\" : \"error\",\n            message: healthy ? \"Health check successful\" : \"Health check failed\",\n            appName: process.env.APP_NAME ?? \"unknown\",\n            appVersion: process.env.APP_VERSION ?? \"unknown\",\n            timestamp: new Date().toISOString(),\n            reports: report,\n        };\n\n        response.statusCode = healthy ? StatusCodes.OK : StatusCodes.SERVICE_UNAVAILABLE;\n\n        if (sendHeader) {\n            response.setHeader(\"Content-Type\", \"application/json\");\n        }\n\n        response.end(JSON.stringify(payload));\n    };\n\nexport type HealthCheckApiPayload = {\n    status: \"ok\" | \"error\";\n    message: string;\n    appName: string;\n    appVersion: string;\n    timestamp: string;\n    reports: HealthReport;\n};\n","import type { IncomingMessage, ServerResponse } from \"node:http\";\nimport { StatusCodes } from \"http-status-codes\";\n\nimport type { HealthCheck } from \"../types\";\n\nexport default <Request extends IncomingMessage, Response extends ServerResponse>(healthCheck: HealthCheck) => async (_request: Request, response: Response) => {\n    const { healthy } = await healthCheck.getReport();\n\n    response.statusCode = healthy ? StatusCodes.NO_CONTENT : StatusCodes.SERVICE_UNAVAILABLE;\n    response.end()\n};\n","import {\n    Checker, HealthCheck as HealthcheckInterface, HealthReport, HealthReportEntry,\n} from \"./types\";\n\nclass Healthcheck implements HealthcheckInterface {\n    /**\n     * A copy of registered checkers\n     */\n    private healthCheckers: { [service: string]: Checker } = {};\n\n    /**\n     * Returns an array of registered services names\n     */\n    public get servicesList(): string[] {\n        return Object.keys(this.healthCheckers);\n    }\n\n    /**\n     * Invokes a given checker to collect the report metrics.\n     */\n    private async invokeChecker(service: string, reportSheet: HealthReport): Promise<boolean> {\n        const checker = this.healthCheckers[service] as Checker;\n\n        let report: HealthReportEntry;\n\n        try {\n            report = await checker();\n\n            report.displayName = report.displayName || service;\n        } catch (error: any) {\n            report = {\n                displayName: service,\n                health: { healthy: false, message: error.message, timestamp: new Date().toISOString() },\n                meta: { fatal: true },\n            };\n        }\n\n        // eslint-disable-next-line no-param-reassign\n        reportSheet[service] = report;\n\n        return report.health.healthy;\n    }\n\n    public addChecker(service: string, checker: Checker): void {\n        this.healthCheckers[service] = checker;\n    }\n\n    /**\n     * Returns the health check reports. The health checks are performed when\n     * this method is invoked.\n     */\n    public async getReport(): Promise<{ healthy: boolean; report: HealthReport }> {\n        const report: HealthReport = {};\n\n        // eslint-disable-next-line compat/compat\n        await Promise.all(Object.keys(this.healthCheckers).map((service) => this.invokeChecker(service, report)));\n\n        /**\n         * Finding unhealthy service to know if system is healthy or not\n         */\n        const unhealthyService = Object.keys(report).find((service) => !(report[service] as HealthReportEntry).health.healthy);\n\n        return { healthy: !unhealthyService, report };\n    }\n\n    public async isLive(): Promise<boolean> {\n        const { healthy } = await this.getReport();\n\n        return healthy;\n    }\n}\n\nexport default Healthcheck;\n","import type { IPFamily, Options } from \"cacheable-lookup\";\nimport CacheableLookup from \"cacheable-lookup\";\n\nimport type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"DNS check for\";\n\n/**\n * Register the `dns` checker to ensure that a domain is reachable.\n */\nconst dnsCheck = (\n    host: string,\n    expectedAddresses?: string[],\n    options?: {\n        family?: IPFamily | \"all\";\n        hints?: number;\n    } & Options,\n): Checker => async () => {\n    const { hints, family = \"all\", ...config } = options || {};\n\n    const cacheable = new CacheableLookup(config);\n\n    try {\n        const meta = await cacheable.lookupAsync(host.replace(/^https?:\\/\\//, \"\"), {\n            hints,\n            ...(family === \"all\" ? { all: true } : { family: family as IPFamily }),\n        });\n\n        if (Array.isArray(expectedAddresses) && !expectedAddresses?.includes(meta.address)) {\n            return {\n                displayName: `${DISPLAY_NAME} ${host}`,\n                health: {\n                    healthy: false,\n                    message: `${DISPLAY_NAME} ${host} returned address ${meta.address} instead of ${expectedAddresses.join(\", \")}.`,\n                    timestamp: new Date().toISOString(),\n                },\n                meta: {\n                    host,\n                    addresses: meta,\n                },\n            };\n        }\n\n        return {\n            displayName: `${DISPLAY_NAME} ${host}`,\n            health: {\n                healthy: true,\n                message: `${DISPLAY_NAME} ${host} were resolved.`,\n                timestamp: new Date().toISOString(),\n            },\n            meta: {\n                host,\n                addresses: meta,\n            },\n        };\n    } catch (error: any) {\n        return {\n            displayName: `${DISPLAY_NAME} ${host}`,\n            health: {\n                healthy: false,\n                message: error.message,\n                timestamp: new Date().toISOString(),\n            },\n            meta: {\n                host,\n            },\n        };\n    }\n};\n\nexport default dnsCheck;\n","import { deepStrictEqual } from \"node:assert\";\n\nimport type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"HTTP check for\";\n\n/**\n * Register the `http` checker to ensure http body and status is correct.\n */\nconst httpCheck =\n    (host: RequestInfo | URL, options?: {\n        fetchOptions?: RequestInit,\n        expected?: { status?: number; body?: string }\n    }): Checker =>\n    async () => {\n        try {\n            // eslint-disable-next-line compat/compat\n            const response = await fetch(host, options?.fetchOptions || {});\n\n            if (typeof options?.expected?.status !== \"undefined\" && options?.expected?.status !== response.status) {\n                throw new Error(`${DISPLAY_NAME} ${host} returned status ${response.status} instead of ${options?.expected.status}`);\n            }\n\n            if (typeof options?.expected?.body !== \"undefined\") {\n                const textBody = await response.text();\n\n                try {\n                    deepStrictEqual(textBody, options?.expected.body);\n                } catch {\n                    throw new Error(`${DISPLAY_NAME} ${host} returned body ${JSON.stringify(textBody)} instead of ${JSON.stringify(options?.expected.body)}`);\n                }\n            }\n\n            return {\n                displayName: `${DISPLAY_NAME} ${host}`,\n                health: {\n                    healthy: true,\n                    message: `${DISPLAY_NAME} ${host} was successful.`,\n                    timestamp: new Date().toISOString(),\n                },\n                meta: {\n                    host,\n                    method: options?.fetchOptions?.method || \"GET\",\n                    status: response.status,\n                },\n            };\n        } catch (error: any) {\n            return {\n                displayName: `${DISPLAY_NAME} ${host}`,\n                health: {\n                    healthy: false,\n                    message: error.message,\n                    timestamp: new Date().toISOString(),\n                },\n                meta: {\n                    host,\n                    method: options?.fetchOptions?.method || \"GET\",\n                },\n            };\n        }\n    };\n\nexport default httpCheck;\n","import type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"Node Environment Check\";\n\n/**\n * Register the `env` checker to ensure that `NODE_ENV` environment\n * variable is defined.\n */\nconst nodeEnvironmentCheck = (expectedEnv?: string): Checker => async () => {\n    const environment = process.env.NODE_ENV;\n\n    let errorMessage: string | undefined;\n\n    if (typeof environment !== \"undefined\" && typeof expectedEnv !== \"undefined\" && environment !== expectedEnv) {\n        errorMessage = `NODE_ENV environment variable is set to \"${environment}\" instead of \"${expectedEnv}\".`;\n    } else if (typeof environment === \"undefined\") {\n        errorMessage = [\"Missing NODE_ENV environment variable.\", \"It can make some parts of the application misbehave\"].join(\" \");\n    }\n\n    if (typeof errorMessage !== \"undefined\") {\n        return {\n            displayName: DISPLAY_NAME,\n            health: {\n                healthy: false,\n                message: errorMessage,\n                timestamp: new Date().toISOString(),\n            },\n        };\n    }\n\n    return {\n        displayName: DISPLAY_NAME,\n        health: {\n            healthy: true,\n            timestamp: new Date().toISOString(),\n        },\n        meta: {\n            env: environment,\n        },\n    };\n};\n\nexport default nodeEnvironmentCheck;\n","import type { extendedPingOptions } from \"pingman\";\nimport ping from \"pingman\";\n\nimport type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"Ping check for\";\n\n/**\n * Register the `ping` checker to ensure that a domain is reachable.\n */\nconst pingCheck = (host: string, options?: extendedPingOptions): Checker => async () => {\n    try {\n        const response = await ping(host.replace(/^https?:\\/\\//, \"\"), options);\n\n        if (!response.alive) {\n            return {\n                displayName: `${DISPLAY_NAME} ${host}`,\n                health: {\n                    healthy: false,\n                    message: `Ping failed for ${host}.`,\n                    timestamp: new Date().toISOString(),\n                },\n                meta: response,\n            };\n        }\n\n        return {\n            displayName: `${DISPLAY_NAME} ${host}`,\n            health: {\n                healthy: true,\n                message: `${DISPLAY_NAME} ${host} was successful.`,\n                timestamp: new Date().toISOString(),\n            },\n            meta: response,\n        };\n    } catch (error: any) {\n        return {\n            displayName: `${DISPLAY_NAME} ${host}`,\n            health: {\n                healthy: false,\n                message: error.message,\n                timestamp: new Date().toISOString(),\n            },\n        };\n    }\n};\n\nexport default pingCheck;\n"]}

package/dist/index.mjs

@@ -0,0 +1,249 @@
+// src/handler/healthcheck.ts
+import { StatusCodes } from "http-status-codes";
+var healthcheck_default = (healthCheck, sendHeader = true) => async (_, response) => {
+  const { healthy, report } = await healthCheck.getReport();
+  const payload = {
+    status: healthy ? "ok" : "error",
+    message: healthy ? "Health check successful" : "Health check failed",
+    appName: process.env.APP_NAME ?? "unknown",
+    appVersion: process.env.APP_VERSION ?? "unknown",
+    timestamp: new Date().toISOString(),
+    reports: report
+  };
+  response.statusCode = healthy ? StatusCodes.OK : StatusCodes.SERVICE_UNAVAILABLE;
+  if (sendHeader) {
+    response.setHeader("Content-Type", "application/json");
+  }
+  response.end(JSON.stringify(payload));
+};
+
+// src/handler/readyhandler.ts
+import { StatusCodes as StatusCodes2 } from "http-status-codes";
+var readyhandler_default = (healthCheck) => async (_request, response) => {
+  const { healthy } = await healthCheck.getReport();
+  response.statusCode = healthy ? StatusCodes2.NO_CONTENT : StatusCodes2.SERVICE_UNAVAILABLE;
+  response.end();
+};
+
+// src/healthcheck.ts
+var Healthcheck = class {
+  constructor() {
+    this.healthCheckers = {};
+  }
+  get servicesList() {
+    return Object.keys(this.healthCheckers);
+  }
+  async invokeChecker(service, reportSheet) {
+    const checker = this.healthCheckers[service];
+    let report;
+    try {
+      report = await checker();
+      report.displayName = report.displayName || service;
+    } catch (error) {
+      report = {
+        displayName: service,
+        health: { healthy: false, message: error.message, timestamp: new Date().toISOString() },
+        meta: { fatal: true }
+      };
+    }
+    reportSheet[service] = report;
+    return report.health.healthy;
+  }
+  addChecker(service, checker) {
+    this.healthCheckers[service] = checker;
+  }
+  async getReport() {
+    const report = {};
+    await Promise.all(Object.keys(this.healthCheckers).map((service) => this.invokeChecker(service, report)));
+    const unhealthyService = Object.keys(report).find((service) => !report[service].health.healthy);
+    return { healthy: !unhealthyService, report };
+  }
+  async isLive() {
+    const { healthy } = await this.getReport();
+    return healthy;
+  }
+};
+var healthcheck_default2 = Healthcheck;
+
+// src/checks/dns-check.ts
+import CacheableLookup from "cacheable-lookup";
+var DISPLAY_NAME = "DNS check for";
+var dnsCheck = (host, expectedAddresses, options) => async () => {
+  const { hints, family = "all", ...config } = options || {};
+  const cacheable = new CacheableLookup(config);
+  try {
+    const meta = await cacheable.lookupAsync(host.replace(/^https?:\/\//, ""), {
+      hints,
+      ...family === "all" ? { all: true } : { family }
+    });
+    if (Array.isArray(expectedAddresses) && !(expectedAddresses == null ? void 0 : expectedAddresses.includes(meta.address))) {
+      return {
+        displayName: `${DISPLAY_NAME} ${host}`,
+        health: {
+          healthy: false,
+          message: `${DISPLAY_NAME} ${host} returned address ${meta.address} instead of ${expectedAddresses.join(", ")}.`,
+          timestamp: new Date().toISOString()
+        },
+        meta: {
+          host,
+          addresses: meta
+        }
+      };
+    }
+    return {
+      displayName: `${DISPLAY_NAME} ${host}`,
+      health: {
+        healthy: true,
+        message: `${DISPLAY_NAME} ${host} were resolved.`,
+        timestamp: new Date().toISOString()
+      },
+      meta: {
+        host,
+        addresses: meta
+      }
+    };
+  } catch (error) {
+    return {
+      displayName: `${DISPLAY_NAME} ${host}`,
+      health: {
+        healthy: false,
+        message: error.message,
+        timestamp: new Date().toISOString()
+      },
+      meta: {
+        host
+      }
+    };
+  }
+};
+var dns_check_default = dnsCheck;
+
+// src/checks/http-check.ts
+import { deepStrictEqual } from "assert";
+var DISPLAY_NAME2 = "HTTP check for";
+var httpCheck = (host, options) => async () => {
+  var _a, _b, _c, _d, _e;
+  try {
+    const response = await fetch(host, (options == null ? void 0 : options.fetchOptions) || {});
+    if (typeof ((_a = options == null ? void 0 : options.expected) == null ? void 0 : _a.status) !== "undefined" && ((_b = options == null ? void 0 : options.expected) == null ? void 0 : _b.status) !== response.status) {
+      throw new Error(`${DISPLAY_NAME2} ${host} returned status ${response.status} instead of ${options == null ? void 0 : options.expected.status}`);
+    }
+    if (typeof ((_c = options == null ? void 0 : options.expected) == null ? void 0 : _c.body) !== "undefined") {
+      const textBody = await response.text();
+      try {
+        deepStrictEqual(textBody, options == null ? void 0 : options.expected.body);
+      } catch {
+        throw new Error(`${DISPLAY_NAME2} ${host} returned body ${JSON.stringify(textBody)} instead of ${JSON.stringify(options == null ? void 0 : options.expected.body)}`);
+      }
+    }
+    return {
+      displayName: `${DISPLAY_NAME2} ${host}`,
+      health: {
+        healthy: true,
+        message: `${DISPLAY_NAME2} ${host} was successful.`,
+        timestamp: new Date().toISOString()
+      },
+      meta: {
+        host,
+        method: ((_d = options == null ? void 0 : options.fetchOptions) == null ? void 0 : _d.method) || "GET",
+        status: response.status
+      }
+    };
+  } catch (error) {
+    return {
+      displayName: `${DISPLAY_NAME2} ${host}`,
+      health: {
+        healthy: false,
+        message: error.message,
+        timestamp: new Date().toISOString()
+      },
+      meta: {
+        host,
+        method: ((_e = options == null ? void 0 : options.fetchOptions) == null ? void 0 : _e.method) || "GET"
+      }
+    };
+  }
+};
+var http_check_default = httpCheck;
+
+// src/checks/node-environment-check.ts
+var DISPLAY_NAME3 = "Node Environment Check";
+var nodeEnvironmentCheck = (expectedEnv) => async () => {
+  const environment = "development";
+  let errorMessage;
+  if (typeof environment !== "undefined" && typeof expectedEnv !== "undefined" && environment !== expectedEnv) {
+    errorMessage = `NODE_ENV environment variable is set to "${environment}" instead of "${expectedEnv}".`;
+  } else if (typeof environment === "undefined") {
+    errorMessage = ["Missing NODE_ENV environment variable.", "It can make some parts of the application misbehave"].join(" ");
+  }
+  if (typeof errorMessage !== "undefined") {
+    return {
+      displayName: DISPLAY_NAME3,
+      health: {
+        healthy: false,
+        message: errorMessage,
+        timestamp: new Date().toISOString()
+      }
+    };
+  }
+  return {
+    displayName: DISPLAY_NAME3,
+    health: {
+      healthy: true,
+      timestamp: new Date().toISOString()
+    },
+    meta: {
+      env: environment
+    }
+  };
+};
+var node_environment_check_default = nodeEnvironmentCheck;
+
+// src/checks/ping-check.ts
+import ping from "pingman";
+var DISPLAY_NAME4 = "Ping check for";
+var pingCheck = (host, options) => async () => {
+  try {
+    const response = await ping(host.replace(/^https?:\/\//, ""), options);
+    if (!response.alive) {
+      return {
+        displayName: `${DISPLAY_NAME4} ${host}`,
+        health: {
+          healthy: false,
+          message: `Ping failed for ${host}.`,
+          timestamp: new Date().toISOString()
+        },
+        meta: response
+      };
+    }
+    return {
+      displayName: `${DISPLAY_NAME4} ${host}`,
+      health: {
+        healthy: true,
+        message: `${DISPLAY_NAME4} ${host} was successful.`,
+        timestamp: new Date().toISOString()
+      },
+      meta: response
+    };
+  } catch (error) {
+    return {
+      displayName: `${DISPLAY_NAME4} ${host}`,
+      health: {
+        healthy: false,
+        message: error.message,
+        timestamp: new Date().toISOString()
+      }
+    };
+  }
+};
+var ping_check_default = pingCheck;
+export {
+  healthcheck_default2 as HealthCheck,
+  dns_check_default as dnsCheck,
+  healthcheck_default as healthCheckHandler,
+  readyhandler_default as healthReadyHandler,
+  http_check_default as httpCheck,
+  node_environment_check_default as nodeEnvCheck,
+  ping_check_default as pingCheck
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/handler/healthcheck.ts","../src/handler/readyhandler.ts","../src/healthcheck.ts","../src/checks/dns-check.ts","../src/checks/http-check.ts","../src/checks/node-environment-check.ts","../src/checks/ping-check.ts"],"sourcesContent":["import { StatusCodes } from \"http-status-codes\";\nimport type { IncomingMessage, ServerResponse } from \"node:http\";\n\nimport type { HealthCheck, HealthReport } from \"../types\";\n\nexport default (healthCheck: HealthCheck, sendHeader: boolean | undefined = true) =>\n    async <Request extends IncomingMessage, Response extends ServerResponse>(_: Request, response: Response) => {\n        const { healthy, report } = await healthCheck.getReport();\n\n        const payload: HealthCheckApiPayload = {\n            status: healthy ? \"ok\" : \"error\",\n            message: healthy ? \"Health check successful\" : \"Health check failed\",\n            appName: process.env.APP_NAME ?? \"unknown\",\n            appVersion: process.env.APP_VERSION ?? \"unknown\",\n            timestamp: new Date().toISOString(),\n            reports: report,\n        };\n\n        response.statusCode = healthy ? StatusCodes.OK : StatusCodes.SERVICE_UNAVAILABLE;\n\n        if (sendHeader) {\n            response.setHeader(\"Content-Type\", \"application/json\");\n        }\n\n        response.end(JSON.stringify(payload));\n    };\n\nexport type HealthCheckApiPayload = {\n    status: \"ok\" | \"error\";\n    message: string;\n    appName: string;\n    appVersion: string;\n    timestamp: string;\n    reports: HealthReport;\n};\n","import type { IncomingMessage, ServerResponse } from \"node:http\";\nimport { StatusCodes } from \"http-status-codes\";\n\nimport type { HealthCheck } from \"../types\";\n\nexport default <Request extends IncomingMessage, Response extends ServerResponse>(healthCheck: HealthCheck) => async (_request: Request, response: Response) => {\n    const { healthy } = await healthCheck.getReport();\n\n    response.statusCode = healthy ? StatusCodes.NO_CONTENT : StatusCodes.SERVICE_UNAVAILABLE;\n    response.end()\n};\n","import {\n    Checker, HealthCheck as HealthcheckInterface, HealthReport, HealthReportEntry,\n} from \"./types\";\n\nclass Healthcheck implements HealthcheckInterface {\n    /**\n     * A copy of registered checkers\n     */\n    private healthCheckers: { [service: string]: Checker } = {};\n\n    /**\n     * Returns an array of registered services names\n     */\n    public get servicesList(): string[] {\n        return Object.keys(this.healthCheckers);\n    }\n\n    /**\n     * Invokes a given checker to collect the report metrics.\n     */\n    private async invokeChecker(service: string, reportSheet: HealthReport): Promise<boolean> {\n        const checker = this.healthCheckers[service] as Checker;\n\n        let report: HealthReportEntry;\n\n        try {\n            report = await checker();\n\n            report.displayName = report.displayName || service;\n        } catch (error: any) {\n            report = {\n                displayName: service,\n                health: { healthy: false, message: error.message, timestamp: new Date().toISOString() },\n                meta: { fatal: true },\n            };\n        }\n\n        // eslint-disable-next-line no-param-reassign\n        reportSheet[service] = report;\n\n        return report.health.healthy;\n    }\n\n    public addChecker(service: string, checker: Checker): void {\n        this.healthCheckers[service] = checker;\n    }\n\n    /**\n     * Returns the health check reports. The health checks are performed when\n     * this method is invoked.\n     */\n    public async getReport(): Promise<{ healthy: boolean; report: HealthReport }> {\n        const report: HealthReport = {};\n\n        // eslint-disable-next-line compat/compat\n        await Promise.all(Object.keys(this.healthCheckers).map((service) => this.invokeChecker(service, report)));\n\n        /**\n         * Finding unhealthy service to know if system is healthy or not\n         */\n        const unhealthyService = Object.keys(report).find((service) => !(report[service] as HealthReportEntry).health.healthy);\n\n        return { healthy: !unhealthyService, report };\n    }\n\n    public async isLive(): Promise<boolean> {\n        const { healthy } = await this.getReport();\n\n        return healthy;\n    }\n}\n\nexport default Healthcheck;\n","import type { IPFamily, Options } from \"cacheable-lookup\";\nimport CacheableLookup from \"cacheable-lookup\";\n\nimport type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"DNS check for\";\n\n/**\n * Register the `dns` checker to ensure that a domain is reachable.\n */\nconst dnsCheck = (\n    host: string,\n    expectedAddresses?: string[],\n    options?: {\n        family?: IPFamily | \"all\";\n        hints?: number;\n    } & Options,\n): Checker => async () => {\n    const { hints, family = \"all\", ...config } = options || {};\n\n    const cacheable = new CacheableLookup(config);\n\n    try {\n        const meta = await cacheable.lookupAsync(host.replace(/^https?:\\/\\//, \"\"), {\n            hints,\n            ...(family === \"all\" ? { all: true } : { family: family as IPFamily }),\n        });\n\n        if (Array.isArray(expectedAddresses) && !expectedAddresses?.includes(meta.address)) {\n            return {\n                displayName: `${DISPLAY_NAME} ${host}`,\n                health: {\n                    healthy: false,\n                    message: `${DISPLAY_NAME} ${host} returned address ${meta.address} instead of ${expectedAddresses.join(\", \")}.`,\n                    timestamp: new Date().toISOString(),\n                },\n                meta: {\n                    host,\n                    addresses: meta,\n                },\n            };\n        }\n\n        return {\n            displayName: `${DISPLAY_NAME} ${host}`,\n            health: {\n                healthy: true,\n                message: `${DISPLAY_NAME} ${host} were resolved.`,\n                timestamp: new Date().toISOString(),\n            },\n            meta: {\n                host,\n                addresses: meta,\n            },\n        };\n    } catch (error: any) {\n        return {\n            displayName: `${DISPLAY_NAME} ${host}`,\n            health: {\n                healthy: false,\n                message: error.message,\n                timestamp: new Date().toISOString(),\n            },\n            meta: {\n                host,\n            },\n        };\n    }\n};\n\nexport default dnsCheck;\n","import { deepStrictEqual } from \"node:assert\";\n\nimport type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"HTTP check for\";\n\n/**\n * Register the `http` checker to ensure http body and status is correct.\n */\nconst httpCheck =\n    (host: RequestInfo | URL, options?: {\n        fetchOptions?: RequestInit,\n        expected?: { status?: number; body?: string }\n    }): Checker =>\n    async () => {\n        try {\n            // eslint-disable-next-line compat/compat\n            const response = await fetch(host, options?.fetchOptions || {});\n\n            if (typeof options?.expected?.status !== \"undefined\" && options?.expected?.status !== response.status) {\n                throw new Error(`${DISPLAY_NAME} ${host} returned status ${response.status} instead of ${options?.expected.status}`);\n            }\n\n            if (typeof options?.expected?.body !== \"undefined\") {\n                const textBody = await response.text();\n\n                try {\n                    deepStrictEqual(textBody, options?.expected.body);\n                } catch {\n                    throw new Error(`${DISPLAY_NAME} ${host} returned body ${JSON.stringify(textBody)} instead of ${JSON.stringify(options?.expected.body)}`);\n                }\n            }\n\n            return {\n                displayName: `${DISPLAY_NAME} ${host}`,\n                health: {\n                    healthy: true,\n                    message: `${DISPLAY_NAME} ${host} was successful.`,\n                    timestamp: new Date().toISOString(),\n                },\n                meta: {\n                    host,\n                    method: options?.fetchOptions?.method || \"GET\",\n                    status: response.status,\n                },\n            };\n        } catch (error: any) {\n            return {\n                displayName: `${DISPLAY_NAME} ${host}`,\n                health: {\n                    healthy: false,\n                    message: error.message,\n                    timestamp: new Date().toISOString(),\n                },\n                meta: {\n                    host,\n                    method: options?.fetchOptions?.method || \"GET\",\n                },\n            };\n        }\n    };\n\nexport default httpCheck;\n","import type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"Node Environment Check\";\n\n/**\n * Register the `env` checker to ensure that `NODE_ENV` environment\n * variable is defined.\n */\nconst nodeEnvironmentCheck = (expectedEnv?: string): Checker => async () => {\n    const environment = process.env.NODE_ENV;\n\n    let errorMessage: string | undefined;\n\n    if (typeof environment !== \"undefined\" && typeof expectedEnv !== \"undefined\" && environment !== expectedEnv) {\n        errorMessage = `NODE_ENV environment variable is set to \"${environment}\" instead of \"${expectedEnv}\".`;\n    } else if (typeof environment === \"undefined\") {\n        errorMessage = [\"Missing NODE_ENV environment variable.\", \"It can make some parts of the application misbehave\"].join(\" \");\n    }\n\n    if (typeof errorMessage !== \"undefined\") {\n        return {\n            displayName: DISPLAY_NAME,\n            health: {\n                healthy: false,\n                message: errorMessage,\n                timestamp: new Date().toISOString(),\n            },\n        };\n    }\n\n    return {\n        displayName: DISPLAY_NAME,\n        health: {\n            healthy: true,\n            timestamp: new Date().toISOString(),\n        },\n        meta: {\n            env: environment,\n        },\n    };\n};\n\nexport default nodeEnvironmentCheck;\n","import type { extendedPingOptions } from \"pingman\";\nimport ping from \"pingman\";\n\nimport type { Checker } from \"../types\";\n\nconst DISPLAY_NAME = \"Ping check for\";\n\n/**\n * Register the `ping` checker to ensure that a domain is reachable.\n */\nconst pingCheck = (host: string, options?: extendedPingOptions): Checker => async () => {\n    try {\n        const response = await ping(host.replace(/^https?:\\/\\//, \"\"), options);\n\n        if (!response.alive) {\n            return {\n                displayName: `${DISPLAY_NAME} ${host}`,\n                health: {\n                    healthy: false,\n                    message: `Ping failed for ${host}.`,\n                    timestamp: new Date().toISOString(),\n                },\n                meta: response,\n            };\n        }\n\n        return {\n            displayName: `${DISPLAY_NAME} ${host}`,\n            health: {\n                healthy: true,\n                message: `${DISPLAY_NAME} ${host} was successful.`,\n                timestamp: new Date().toISOString(),\n            },\n            meta: response,\n        };\n    } catch (error: any) {\n        return {\n            displayName: `${DISPLAY_NAME} ${host}`,\n            health: {\n                healthy: false,\n                message: error.message,\n                timestamp: new Date().toISOString(),\n            },\n        };\n    }\n};\n\nexport default pingCheck;\n"],"mappings":";AAAA,SAAS,mBAAmB;AAK5B,IAAO,sBAAQ,CAAC,aAA0B,aAAkC,SACxE,OAAyE,GAAY,aAAuB;AACxG,QAAM,EAAE,SAAS,OAAO,IAAI,MAAM,YAAY,UAAU;AAExD,QAAM,UAAiC;AAAA,IACnC,QAAQ,UAAU,OAAO;AAAA,IACzB,SAAS,UAAU,4BAA4B;AAAA,IAC/C,SAAS,QAAQ,IAAI,YAAY;AAAA,IACjC,YAAY,QAAQ,IAAI,eAAe;AAAA,IACvC,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,IAClC,SAAS;AAAA,EACb;AAEA,WAAS,aAAa,UAAU,YAAY,KAAK,YAAY;AAE7D,MAAI,YAAY;AACZ,aAAS,UAAU,gBAAgB,kBAAkB;AAAA,EACzD;AAEA,WAAS,IAAI,KAAK,UAAU,OAAO,CAAC;AACxC;;;ACxBJ,SAAS,eAAAA,oBAAmB;AAI5B,IAAO,uBAAQ,CAAmE,gBAA6B,OAAO,UAAmB,aAAuB;AAC5J,QAAM,EAAE,QAAQ,IAAI,MAAM,YAAY,UAAU;AAEhD,WAAS,aAAa,UAAUA,aAAY,aAAaA,aAAY;AACrE,WAAS,IAAI;AACjB;;;ACNA,IAAM,cAAN,MAAkD;AAAA,EAAlD;AAII,SAAQ,iBAAiD,CAAC;AAAA;AAAA,EAK1D,IAAW,eAAyB;AAChC,WAAO,OAAO,KAAK,KAAK,cAAc;AAAA,EAC1C;AAAA,EAKA,MAAc,cAAc,SAAiB,aAA6C;AACtF,UAAM,UAAU,KAAK,eAAe;AAEpC,QAAI;AAEJ,QAAI;AACA,eAAS,MAAM,QAAQ;AAEvB,aAAO,cAAc,OAAO,eAAe;AAAA,IAC/C,SAAS,OAAP;AACE,eAAS;AAAA,QACL,aAAa;AAAA,QACb,QAAQ,EAAE,SAAS,OAAO,SAAS,MAAM,SAAS,WAAW,IAAI,KAAK,EAAE,YAAY,EAAE;AAAA,QACtF,MAAM,EAAE,OAAO,KAAK;AAAA,MACxB;AAAA,IACJ;AAGA,gBAAY,WAAW;AAEvB,WAAO,OAAO,OAAO;AAAA,EACzB;AAAA,EAEO,WAAW,SAAiB,SAAwB;AACvD,SAAK,eAAe,WAAW;AAAA,EACnC;AAAA,EAMA,MAAa,YAAiE;AAC1E,UAAM,SAAuB,CAAC;AAG9B,UAAM,QAAQ,IAAI,OAAO,KAAK,KAAK,cAAc,EAAE,IAAI,CAAC,YAAY,KAAK,cAAc,SAAS,MAAM,CAAC,CAAC;AAKxG,UAAM,mBAAmB,OAAO,KAAK,MAAM,EAAE,KAAK,CAAC,YAAY,CAAE,OAAO,SAA+B,OAAO,OAAO;AAErH,WAAO,EAAE,SAAS,CAAC,kBAAkB,OAAO;AAAA,EAChD;AAAA,EAEA,MAAa,SAA2B;AACpC,UAAM,EAAE,QAAQ,IAAI,MAAM,KAAK,UAAU;AAEzC,WAAO;AAAA,EACX;AACJ;AAEA,IAAOC,uBAAQ;;;ACvEf,OAAO,qBAAqB;AAI5B,IAAM,eAAe;AAKrB,IAAM,WAAW,CACb,MACA,mBACA,YAIU,YAAY;AACtB,QAAM,EAAE,OAAO,SAAS,UAAU,OAAO,IAAI,WAAW,CAAC;AAEzD,QAAM,YAAY,IAAI,gBAAgB,MAAM;AAE5C,MAAI;AACA,UAAM,OAAO,MAAM,UAAU,YAAY,KAAK,QAAQ,gBAAgB,EAAE,GAAG;AAAA,MACvE;AAAA,MACA,GAAI,WAAW,QAAQ,EAAE,KAAK,KAAK,IAAI,EAAE,OAA2B;AAAA,IACxE,CAAC;AAED,QAAI,MAAM,QAAQ,iBAAiB,KAAK,EAAC,uDAAmB,SAAS,KAAK,WAAU;AAChF,aAAO;AAAA,QACH,aAAa,GAAG,gBAAgB;AAAA,QAChC,QAAQ;AAAA,UACJ,SAAS;AAAA,UACT,SAAS,GAAG,gBAAgB,yBAAyB,KAAK,sBAAsB,kBAAkB,KAAK,IAAI;AAAA,UAC3G,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,QACtC;AAAA,QACA,MAAM;AAAA,UACF;AAAA,UACA,WAAW;AAAA,QACf;AAAA,MACJ;AAAA,IACJ;AAEA,WAAO;AAAA,MACH,aAAa,GAAG,gBAAgB;AAAA,MAChC,QAAQ;AAAA,QACJ,SAAS;AAAA,QACT,SAAS,GAAG,gBAAgB;AAAA,QAC5B,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,MACtC;AAAA,MACA,MAAM;AAAA,QACF;AAAA,QACA,WAAW;AAAA,MACf;AAAA,IACJ;AAAA,EACJ,SAAS,OAAP;AACE,WAAO;AAAA,MACH,aAAa,GAAG,gBAAgB;AAAA,MAChC,QAAQ;AAAA,QACJ,SAAS;AAAA,QACT,SAAS,MAAM;AAAA,QACf,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,MACtC;AAAA,MACA,MAAM;AAAA,QACF;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AACJ;AAEA,IAAO,oBAAQ;;;ACtEf,SAAS,uBAAuB;AAIhC,IAAMC,gBAAe;AAKrB,IAAM,YACF,CAAC,MAAyB,YAI1B,YAAY;AAdhB;AAeQ,MAAI;AAEA,UAAM,WAAW,MAAM,MAAM,OAAM,mCAAS,iBAAgB,CAAC,CAAC;AAE9D,QAAI,SAAO,wCAAS,aAAT,mBAAmB,YAAW,iBAAe,wCAAS,aAAT,mBAAmB,YAAW,SAAS,QAAQ;AACnG,YAAM,IAAI,MAAM,GAAGA,iBAAgB,wBAAwB,SAAS,qBAAqB,mCAAS,SAAS,QAAQ;AAAA,IACvH;AAEA,QAAI,SAAO,wCAAS,aAAT,mBAAmB,UAAS,aAAa;AAChD,YAAM,WAAW,MAAM,SAAS,KAAK;AAErC,UAAI;AACA,wBAAgB,UAAU,mCAAS,SAAS,IAAI;AAAA,MACpD,QAAE;AACE,cAAM,IAAI,MAAM,GAAGA,iBAAgB,sBAAsB,KAAK,UAAU,QAAQ,gBAAgB,KAAK,UAAU,mCAAS,SAAS,IAAI,GAAG;AAAA,MAC5I;AAAA,IACJ;AAEA,WAAO;AAAA,MACH,aAAa,GAAGA,iBAAgB;AAAA,MAChC,QAAQ;AAAA,QACJ,SAAS;AAAA,QACT,SAAS,GAAGA,iBAAgB;AAAA,QAC5B,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,MACtC;AAAA,MACA,MAAM;AAAA,QACF;AAAA,QACA,UAAQ,wCAAS,iBAAT,mBAAuB,WAAU;AAAA,QACzC,QAAQ,SAAS;AAAA,MACrB;AAAA,IACJ;AAAA,EACJ,SAAS,OAAP;AACE,WAAO;AAAA,MACH,aAAa,GAAGA,iBAAgB;AAAA,MAChC,QAAQ;AAAA,QACJ,SAAS;AAAA,QACT,SAAS,MAAM;AAAA,QACf,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,MACtC;AAAA,MACA,MAAM;AAAA,QACF;AAAA,QACA,UAAQ,wCAAS,iBAAT,mBAAuB,WAAU;AAAA,MAC7C;AAAA,IACJ;AAAA,EACJ;AACJ;AAEJ,IAAO,qBAAQ;;;AC5Df,IAAMC,gBAAe;AAMrB,IAAM,uBAAuB,CAAC,gBAAkC,YAAY;AACxE,QAAM,cAAc;AAEpB,MAAI;AAEJ,MAAI,OAAO,gBAAgB,eAAe,OAAO,gBAAgB,eAAe,gBAAgB,aAAa;AACzG,mBAAe,4CAA4C,4BAA4B;AAAA,EAC3F,WAAW,OAAO,gBAAgB,aAAa;AAC3C,mBAAe,CAAC,0CAA0C,qDAAqD,EAAE,KAAK,GAAG;AAAA,EAC7H;AAEA,MAAI,OAAO,iBAAiB,aAAa;AACrC,WAAO;AAAA,MACH,aAAaA;AAAA,MACb,QAAQ;AAAA,QACJ,SAAS;AAAA,QACT,SAAS;AAAA,QACT,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,MACtC;AAAA,IACJ;AAAA,EACJ;AAEA,SAAO;AAAA,IACH,aAAaA;AAAA,IACb,QAAQ;AAAA,MACJ,SAAS;AAAA,MACT,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,IACtC;AAAA,IACA,MAAM;AAAA,MACF,KAAK;AAAA,IACT;AAAA,EACJ;AACJ;AAEA,IAAO,iCAAQ;;;ACzCf,OAAO,UAAU;AAIjB,IAAMC,gBAAe;AAKrB,IAAM,YAAY,CAAC,MAAc,YAA2C,YAAY;AACpF,MAAI;AACA,UAAM,WAAW,MAAM,KAAK,KAAK,QAAQ,gBAAgB,EAAE,GAAG,OAAO;AAErE,QAAI,CAAC,SAAS,OAAO;AACjB,aAAO;AAAA,QACH,aAAa,GAAGA,iBAAgB;AAAA,QAChC,QAAQ;AAAA,UACJ,SAAS;AAAA,UACT,SAAS,mBAAmB;AAAA,UAC5B,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,QACtC;AAAA,QACA,MAAM;AAAA,MACV;AAAA,IACJ;AAEA,WAAO;AAAA,MACH,aAAa,GAAGA,iBAAgB;AAAA,MAChC,QAAQ;AAAA,QACJ,SAAS;AAAA,QACT,SAAS,GAAGA,iBAAgB;AAAA,QAC5B,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,MACtC;AAAA,MACA,MAAM;AAAA,IACV;AAAA,EACJ,SAAS,OAAP;AACE,WAAO;AAAA,MACH,aAAa,GAAGA,iBAAgB;AAAA,MAChC,QAAQ;AAAA,QACJ,SAAS;AAAA,QACT,SAAS,MAAM;AAAA,QACf,WAAW,IAAI,KAAK,EAAE,YAAY;AAAA,MACtC;AAAA,IACJ;AAAA,EACJ;AACJ;AAEA,IAAO,qBAAQ;","names":["StatusCodes","healthcheck_default","DISPLAY_NAME","DISPLAY_NAME","DISPLAY_NAME"]}

package/package.json

@@ -0,0 +1,127 @@
+{
+    "name": "@visulima/health-check",
+    "version": "1.0.0",
+    "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",
+        "visulima",
+        "blitz",
+        "blitzjs",
+        "nextjs",
+        "health",
+        "check",
+        "checks",
+        "dns-check",
+        "http-check",
+        "ping-check"
+    ],
+    "homepage": "https://visulima.com/packages/health-check",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/visulima/visulima.git",
+        "directory": "packages/health-check"
+    },
+    "funding": [
+        {
+            "type": "github",
+            "url": "https://github.com/sponsors/prisis"
+        },
+        {
+            "type": "consulting",
+            "url": "https://anolilab.com/support"
+        }
+    ],
+    "license": "MIT",
+    "author": {
+        "name": "Daniel Bannert",
+        "email": "d.bannert@anolilab.de"
+    },
+    "sideEffects": false,
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "require": "./dist/index.js",
+            "import": "./dist/index.mjs"
+        },
+        "./package.json": "./package.json"
+    },
+    "main": "dist/index.js",
+    "module": "dist/index.mjs",
+    "source": "src/index.ts",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist/**",
+        "README.md",
+        "CHANGELOG.md",
+        "LICENSE.md"
+    ],
+    "scripts": {
+        "build": "cross-env NODE_ENV=development tsup",
+        "build:prod": "cross-env NODE_ENV=production tsup",
+        "clean": "rimraf node_modules dist",
+        "coverage": "vitest run --coverage",
+        "dev": "pnpm predev && pnpm run build --watch",
+        "lint:eslint": "cross-env NO_LOGS=true eslint --ext js,jsx,ts,tsx --max-warnings=0 --config .eslintrc.cjs",
+        "lint:eslint:fix": "pnpm run lint:eslint --fix",
+        "test": "vitest"
+    },
+    "dependencies": {
+        "cacheable-lookup": "^7.0.0",
+        "http-status-codes": "^2.2.0",
+        "pingman": "^1.1.5"
+    },
+    "devDependencies": {
+        "@anolilab/eslint-config": "^4.0.9",
+        "@anolilab/semantic-release-preset": "^2.0.7",
+        "@rushstack/eslint-plugin-security": "^0.5.0",
+        "@types/node": "^18.8.4",
+        "@types/react": "^18.0.21",
+        "@types/react-dom": "^18.0.6",
+        "@typescript-eslint/eslint-plugin": "^5.40.0",
+        "@typescript-eslint/parser": "^5.40.0",
+        "cross-env": "^7.0.3",
+        "cross-fetch": "^3.1.5",
+        "eslint": "^8.25.0",
+        "eslint-plugin-compat": "^4.0.2",
+        "eslint-plugin-eslint-comments": "^3.2.0",
+        "eslint-plugin-import": "^2.26.0",
+        "eslint-plugin-json": "^3.1.0",
+        "eslint-plugin-jsx-a11y": "^6.6.1",
+        "eslint-plugin-markdown": "^3.0.0",
+        "eslint-plugin-no-loops": "^0.3.0",
+        "eslint-plugin-no-secrets": "^0.8.9",
+        "eslint-plugin-node": "^11.1.0",
+        "eslint-plugin-optimize-regex": "^1.2.1",
+        "eslint-plugin-promise": "^6.0.1",
+        "eslint-plugin-radar": "^0.2.1",
+        "eslint-plugin-react": "7.31.10",
+        "eslint-plugin-react-hooks": "4.6.0",
+        "eslint-plugin-simple-import-sort": "^8.0.0",
+        "eslint-plugin-sort-keys-fix": "^1.1.2",
+        "eslint-plugin-testing-library": "^5.7.2",
+        "eslint-plugin-unicorn": "^44.0.2",
+        "eslint-plugin-you-dont-need-lodash-underscore": "^6.12.0",
+        "eslint-plugin-you-dont-need-momentjs": "^1.6.0",
+        "next": "^12.3.1",
+        "next-test-api-route-handler": "^4.0.0-canary.1",
+        "node-mocks-http": "^1.11.0",
+        "prettier": "^2.7.1",
+        "react": "^18.2.0",
+        "react-dom": "^18.2.0",
+        "read-pkg": "^7.1.0",
+        "rimraf": "^3.0.2",
+        "semantic-release": "^19.0.5",
+        "tsup": "^6.2.3",
+        "typescript": "^4.8.4",
+        "vitest": "^0.24.1"
+    },
+    "optionalDependencies": {
+        "next": "^12.3.1"
+    },
+    "engines": {
+        "node": ">=16"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}