@openstatus/health-nats 0.1.4-dev.0

package/README.md

@@ -0,0 +1,70 @@
+# @openstatus/health-nats
+
+[NATS](https://nats.io/) probe for
+[`@openstatus/health`](https://jsr.io/@openstatus/health). Flushes a
+`NatsConnection` — one `PING` / `PONG` round trip with the server — and
+fails the check when the server does not answer or the connection has been
+closed.
+
+```sh
+deno add jsr:@openstatus/health jsr:@openstatus/health-nats
+npm install @openstatus/health @openstatus/health-nats
+```
+
+```ts
+import { connect } from "@nats-io/transport-node";
+import { createHealthHandler } from "@openstatus/health";
+import { natsProbe } from "@openstatus/health-nats";
+
+const nc = await connect({ servers: env.NATS_URL });
+
+Deno.serve(
+  createHealthHandler({ probes: [natsProbe({ connection: nc })] }),
+);
+```
+
+Reuse the connection your application already holds: NATS clients keep one
+multiplexed connection per process and reconnect on their own, so the probe
+reports what your publishers and subscribers actually see. While the client
+is reconnecting, `flush()` waits until the server is back — set `timeoutMs`
+to bound that. Any of the official clients works: `@nats-io/transport-node`,
+`@nats-io/transport-deno`, the websocket transport and the legacy `nats`
+package all expose the same `flush()` and `isClosed()`.
+
+```ts
+natsProbe({
+  connection: nc,
+  // optional overrides from the Probe contract
+  name: "events",
+  critical: true,
+  timeoutMs: 1000,
+  skip: () => env.NATS_URL == null,
+});
+```
+
+Non-critical by default: messaging usually carries background work, so an
+outage degrades the report instead of taking the service out of rotation.
+Set `critical: true` when requests cannot complete without publishing.
+
+The connection is typed structurally as `{ flush(), isClosed?() }`, so the
+NATS packages are optional peer dependencies for their types only and the
+probe adds no runtime import of them. The factory throws `ProbeConfigError`
+at construction when the connection has no `flush()`.
+
+## About openstatus
+
+[openstatus](https://www.openstatus.dev/) is the open-source uptime monitoring
+and status page platform. This package is part of
+[`@openstatus/health`](https://github.com/openstatusHQ/health), the `/health`
+endpoints behind openstatus's own services, extracted so any JavaScript server
+can expose one. Point an
+[openstatus monitor](https://www.openstatus.dev/docs/reference/http-monitor)
+at the endpoint and assert on `status` in the body to be alerted on
+`degraded` before it becomes `unhealthy`.
+
+Source: [github.com/openstatusHQ/health](https://github.com/openstatusHQ/health).
+Issues and PRs welcome.
+
+## License
+
+[MIT](https://github.com/openstatusHQ/health/blob/main/LICENSE)

package/dist/_virtual/rolldown_runtime.cjs

@@ -0,0 +1,30 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+
+Object.defineProperty(exports, '__toESM', {
+  enumerable: true,
+  get: function () {
+    return __toESM;
+  }
+});

package/dist/mod.cjs

@@ -0,0 +1,31 @@
+const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
+const __openstatus_health = require_rolldown_runtime.__toESM(require("@openstatus/health"));
+
+//#region src/mod.ts
+/** Probe name when `name` is unset. */
+const natsDefaultName = "nats";
+/** A probe that flushes the connection; non-critical by default. Throws `ProbeConfigError` without `flush()`. */
+function natsProbe(options) {
+	const connection = options.connection;
+	if (typeof connection?.flush !== "function") throw new __openstatus_health.ProbeConfigError("natsProbe", "connection", `must expose flush(), got ${describe(connection)}`);
+	return {
+		name: options.name ?? natsDefaultName,
+		critical: options.critical ?? false,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: async () => {
+			if (typeof connection.isClosed === "function" && connection.isClosed()) throw new Error("connection closed");
+			await connection.flush();
+		}
+	};
+}
+function describe(connection) {
+	if (connection == null) return String(connection);
+	if (typeof connection !== "object") return typeof connection;
+	const keys = Object.keys(connection);
+	return keys.length === 0 ? "an object with no keys" : `an object with keys ${keys.slice(0, 8).join(", ")}`;
+}
+
+//#endregion
+exports.natsDefaultName = natsDefaultName;
+exports.natsProbe = natsProbe;

package/dist/mod.d.cts

@@ -0,0 +1,24 @@
+import { Probe, ProbeOverrides } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** Probe name when `name` is unset. */
+declare const natsDefaultName = "nats";
+/** The subset of a `NatsConnection` the probe uses. */
+interface NatsLikeConnection {
+  /** Resolve once the server has acknowledged everything sent so far. */
+  flush(): PromiseLike<void>;
+  /** Whether the connection has been closed. */
+  isClosed?(): boolean;
+}
+/** Options for `natsProbe()`. */
+interface NatsProbeOptions extends ProbeOverrides {
+  /** An open `NatsConnection`. */
+  readonly connection: NatsLikeConnection;
+}
+/** A probe that flushes the connection; non-critical by default. Throws `ProbeConfigError` without `flush()`. */
+declare function natsProbe(options: NatsProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { NatsLikeConnection, NatsProbeOptions, natsDefaultName, natsProbe };
+//# sourceMappingURL=mod.d.cts.map

package/dist/mod.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.cts","names":[],"sources":["../src/mod.ts"],"sourcesContent":[],"mappings":";;;;;cAsBa,eAAA;;UAGI,kBAAA;;WAEN;;;;;UAMM,gBAAA,SAAyB;;uBAEnB;;;iBAIP,SAAA,UAAmB,mBAAmB"}

package/dist/mod.d.ts

@@ -0,0 +1,24 @@
+import { Probe, ProbeOverrides } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** Probe name when `name` is unset. */
+declare const natsDefaultName = "nats";
+/** The subset of a `NatsConnection` the probe uses. */
+interface NatsLikeConnection {
+  /** Resolve once the server has acknowledged everything sent so far. */
+  flush(): PromiseLike<void>;
+  /** Whether the connection has been closed. */
+  isClosed?(): boolean;
+}
+/** Options for `natsProbe()`. */
+interface NatsProbeOptions extends ProbeOverrides {
+  /** An open `NatsConnection`. */
+  readonly connection: NatsLikeConnection;
+}
+/** A probe that flushes the connection; non-critical by default. Throws `ProbeConfigError` without `flush()`. */
+declare function natsProbe(options: NatsProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { NatsLikeConnection, NatsProbeOptions, natsDefaultName, natsProbe };
+//# sourceMappingURL=mod.d.ts.map

package/dist/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","names":[],"sources":["../src/mod.ts"],"sourcesContent":[],"mappings":";;;;;cAsBa,eAAA;;UAGI,kBAAA;;WAEN;;;;;UAMM,gBAAA,SAAyB;;uBAEnB;;;iBAIP,SAAA,UAAmB,mBAAmB"}

package/dist/mod.js

@@ -0,0 +1,30 @@
+import { ProbeConfigError } from "@openstatus/health";
+
+//#region src/mod.ts
+/** Probe name when `name` is unset. */
+const natsDefaultName = "nats";
+/** A probe that flushes the connection; non-critical by default. Throws `ProbeConfigError` without `flush()`. */
+function natsProbe(options) {
+	const connection = options.connection;
+	if (typeof connection?.flush !== "function") throw new ProbeConfigError("natsProbe", "connection", `must expose flush(), got ${describe(connection)}`);
+	return {
+		name: options.name ?? natsDefaultName,
+		critical: options.critical ?? false,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: async () => {
+			if (typeof connection.isClosed === "function" && connection.isClosed()) throw new Error("connection closed");
+			await connection.flush();
+		}
+	};
+}
+function describe(connection) {
+	if (connection == null) return String(connection);
+	if (typeof connection !== "object") return typeof connection;
+	const keys = Object.keys(connection);
+	return keys.length === 0 ? "an object with no keys" : `an object with keys ${keys.slice(0, 8).join(", ")}`;
+}
+
+//#endregion
+export { natsDefaultName, natsProbe };
+//# sourceMappingURL=mod.js.map

package/dist/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","names":["options: NatsProbeOptions","connection: NatsLikeConnection"],"sources":["../src/mod.ts"],"sourcesContent":["/**\n * NATS probe for `@openstatus/health`: flushes a `NatsConnection`, which\n * round-trips a `PING` / `PONG` with the server.\n *\n * ```ts\n * import { connect } from \"@nats-io/transport-node\";\n * import { natsProbe } from \"@openstatus/health-nats\";\n *\n * const nc = await connect({ servers: env.NATS_URL });\n * const probe = natsProbe({ connection: nc });\n * ```\n *\n * @module\n */\n\nimport {\n  type Probe,\n  ProbeConfigError,\n  type ProbeOverrides,\n} from \"@openstatus/health\";\n\n/** Probe name when `name` is unset. */\nexport const natsDefaultName = \"nats\";\n\n/** The subset of a `NatsConnection` the probe uses. */\nexport interface NatsLikeConnection {\n  /** Resolve once the server has acknowledged everything sent so far. */\n  flush(): PromiseLike<void>;\n  /** Whether the connection has been closed. */\n  isClosed?(): boolean;\n}\n\n/** Options for `natsProbe()`. */\nexport interface NatsProbeOptions extends ProbeOverrides {\n  /** An open `NatsConnection`. */\n  readonly connection: NatsLikeConnection;\n}\n\n/** A probe that flushes the connection; non-critical by default. Throws `ProbeConfigError` without `flush()`. */\nexport function natsProbe(options: NatsProbeOptions): Probe {\n  const connection = options.connection;\n  if (typeof connection?.flush !== \"function\") {\n    throw new ProbeConfigError(\n      \"natsProbe\",\n      \"connection\",\n      `must expose flush(), got ${describe(connection)}`,\n    );\n  }\n  return {\n    name: options.name ?? natsDefaultName,\n    critical: options.critical ?? false,\n    timeoutMs: options.timeoutMs,\n    skip: options.skip,\n    run: async () => {\n      if (typeof connection.isClosed === \"function\" && connection.isClosed()) {\n        throw new Error(\"connection closed\");\n      }\n      await connection.flush();\n    },\n  };\n}\n\nfunction describe(connection: NatsLikeConnection): string {\n  if (connection == null) return String(connection);\n  if (typeof connection !== \"object\") return typeof connection;\n  const keys = Object.keys(connection);\n  return keys.length === 0\n    ? \"an object with no keys\"\n    : `an object with keys ${keys.slice(0, 8).join(\", \")}`;\n}\n"],"mappings":";;;;AAsBA,MAAa,kBAAkB;;AAiB/B,SAAgB,UAAUA,SAAkC;CAC1D,MAAM,aAAa,QAAQ;AAC3B,YAAW,YAAY,UAAU,WAC/B,OAAM,IAAI,iBACR,aACA,eACC,2BAA2B,SAAS,WAAW,CAAC;AAGrD,QAAO;EACL,MAAM,QAAQ,QAAQ;EACtB,UAAU,QAAQ,YAAY;EAC9B,WAAW,QAAQ;EACnB,MAAM,QAAQ;EACd,KAAK,YAAY;AACf,cAAW,WAAW,aAAa,cAAc,WAAW,UAAU,CACpE,OAAM,IAAI,MAAM;AAElB,SAAM,WAAW,OAAO;EACzB;CACF;AACF;AAED,SAAS,SAASC,YAAwC;AACxD,KAAI,cAAc,KAAM,QAAO,OAAO,WAAW;AACjD,YAAW,eAAe,SAAU,eAAc;CAClD,MAAM,OAAO,OAAO,KAAK,WAAW;AACpC,QAAO,KAAK,WAAW,IACnB,4BACC,sBAAsB,KAAK,MAAM,GAAG,EAAE,CAAC,KAAK,KAAK,CAAC;AACxD"}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@openstatus/health-nats",
+  "version": "0.1.4-dev.0",
+  "description": "NATS probe for @openstatus/health",
+  "keywords": [
+    "openstatus",
+    "health",
+    "healthcheck",
+    "nats",
+    "messaging",
+    "pubsub",
+    "jetstream"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "openstatus",
+    "url": "https://www.openstatus.dev/"
+  },
+  "homepage": "https://github.com/openstatusHQ/health",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/openstatusHQ/health.git",
+    "directory": "packages/nats/"
+  },
+  "bugs": {
+    "url": "https://github.com/openstatusHQ/health/issues"
+  },
+  "type": "module",
+  "module": "./dist/mod.js",
+  "main": "./dist/mod.cjs",
+  "types": "./dist/mod.d.ts",
+  "exports": {
+    ".": {
+      "types": {
+        "import": "./dist/mod.d.ts",
+        "require": "./dist/mod.d.cts"
+      },
+      "import": "./dist/mod.js",
+      "require": "./dist/mod.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist/"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "peerDependencies": {
+    "@openstatus/health": "^0.1.4-dev.0",
+    "@nats-io/nats-core": ">=3.0.0",
+    "nats": ">=2.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@nats-io/nats-core": {
+      "optional": true
+    },
+    "nats": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "tsdown": "^0.12.7",
+    "typescript": "^5.8.3"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "prepack": "tsdown",
+    "test": "node --experimental-transform-types --test"
+  }
+}