@openstatus/health-typesense 0.1.4-dev.0

package/README.md

@@ -0,0 +1,76 @@
+# @openstatus/health-typesense
+
+[Typesense](https://typesense.org/) probe for
+[`@openstatus/health`](https://jsr.io/@openstatus/health). Sends
+`GET {host}/health` and fails the check unless the node answers 2xx with
+`{ "ok": true }` — with `fetch` alone, on every runtime, against Typesense
+Cloud or your own cluster.
+
+```sh
+deno add jsr:@openstatus/health jsr:@openstatus/health-typesense
+npm install @openstatus/health @openstatus/health-typesense
+```
+
+```ts
+import { createHealthHandler, readEnv } from "@openstatus/health";
+import { typesenseProbe } from "@openstatus/health-typesense";
+
+const host = readEnv("TYPESENSE_HOST");
+
+Deno.serve(
+  createHealthHandler({
+    probes: [
+      // the factory validates `host` at construction, so pass a placeholder
+      // and let `skip` keep the unconfigured check from running.
+      typesenseProbe({
+        host: host ?? "http://localhost:8108",
+        skip: () => host == null,
+      }),
+    ],
+  }),
+);
+```
+
+`host` is a node URL — `https://xxx.a1.typesense.net` on Cloud or
+`http://localhost:8108` locally. `/health` is the endpoint Typesense
+documents for exactly this: it needs no API key, has no side effects and
+answers `ok: false` while the node is still catching up on a cluster, which
+the probe reports as a failed check. Pass `apiKey` to send one anyway when a
+proxy in front of the node requires it. Like every probe here, this one
+never reads the environment itself — pass the values in, and use `skip` for
+environments where Typesense is not configured.
+
+```ts
+typesenseProbe({
+  host,
+  apiKey: env.TYPESENSE_API_KEY,
+  // optional overrides from the Probe contract
+  name: "typesense",
+  critical: true,
+  timeoutMs: 1000,
+  skip: () => env.TYPESENSE_HOST == null,
+});
+```
+
+Non-critical by default: search is usually one feature of a service rather
+than its request path, so an outage degrades the report instead of taking
+the service out of rotation. Set `critical: true` when requests cannot be
+served without it.
+
+## 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,41 @@
+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 typesenseDefaultName = "search";
+/** A probe that expects `GET {host}/health` to answer 2xx with `ok: true`; non-critical by default. Throws `ProbeConfigError` for an invalid `host` or an empty `apiKey`. */
+function typesenseProbe(options) {
+	const doFetch = options.fetch ?? globalThis.fetch;
+	const url = (0, __openstatus_health.probeUrl)({
+		probe: "typesenseProbe",
+		field: "host",
+		value: options.host,
+		path: "/health"
+	});
+	if (options.apiKey != null && options.apiKey.length === 0) throw new __openstatus_health.ProbeConfigError("typesenseProbe", "apiKey", "must not be empty");
+	const headers = options.apiKey == null ? void 0 : { "x-typesense-api-key": options.apiKey };
+	return {
+		name: options.name ?? typesenseDefaultName,
+		critical: options.critical ?? false,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: async (signal) => {
+			const res = await doFetch(url, {
+				method: "GET",
+				headers,
+				signal
+			});
+			if (!res.ok) {
+				await res.body?.cancel();
+				throw new Error(`unexpected status ${res.status}`);
+			}
+			const body = await res.json().catch(() => null);
+			if (body?.ok !== true) throw new Error(`unexpected health body ${JSON.stringify(body)}`);
+		}
+	};
+}
+
+//#endregion
+exports.typesenseDefaultName = typesenseDefaultName;
+exports.typesenseProbe = typesenseProbe;

package/dist/mod.d.cts

@@ -0,0 +1,21 @@
+import { Probe, ProbeOverrides } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** Probe name when `name` is unset. */
+declare const typesenseDefaultName = "search";
+/** Options for `typesenseProbe()`. */
+interface TypesenseProbeOptions extends ProbeOverrides {
+  /** The node URL, e.g. `https://xxx.a1.typesense.net` or `http://localhost:8108`. */
+  readonly host: string | URL;
+  /** An API key, sent as `x-typesense-api-key`. `/health` does not need one. */
+  readonly apiKey?: string;
+  /** Replacement `fetch`, for tests. */
+  readonly fetch?: typeof fetch;
+}
+/** A probe that expects `GET {host}/health` to answer 2xx with `ok: true`; non-critical by default. Throws `ProbeConfigError` for an invalid `host` or an empty `apiKey`. */
+declare function typesenseProbe(options: TypesenseProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { TypesenseProbeOptions, typesenseDefaultName, typesenseProbe };
+//# 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":";;;;;AAkCqE,cAbxD,oBAAA,GAawD,QAAA;;UAVpD,qBAAA,SAA8B;;0BAErB;;;;0BAIA;;;iBAIV,cAAA,UAAwB,wBAAwB"}

package/dist/mod.d.ts

@@ -0,0 +1,21 @@
+import { Probe, ProbeOverrides } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** Probe name when `name` is unset. */
+declare const typesenseDefaultName = "search";
+/** Options for `typesenseProbe()`. */
+interface TypesenseProbeOptions extends ProbeOverrides {
+  /** The node URL, e.g. `https://xxx.a1.typesense.net` or `http://localhost:8108`. */
+  readonly host: string | URL;
+  /** An API key, sent as `x-typesense-api-key`. `/health` does not need one. */
+  readonly apiKey?: string;
+  /** Replacement `fetch`, for tests. */
+  readonly fetch?: typeof fetch;
+}
+/** A probe that expects `GET {host}/health` to answer 2xx with `ok: true`; non-critical by default. Throws `ProbeConfigError` for an invalid `host` or an empty `apiKey`. */
+declare function typesenseProbe(options: TypesenseProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { TypesenseProbeOptions, typesenseDefaultName, typesenseProbe };
+//# 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":";;;;;AAkCqE,cAbxD,oBAAA,GAawD,QAAA;;UAVpD,qBAAA,SAA8B;;0BAErB;;;;0BAIA;;;iBAIV,cAAA,UAAwB,wBAAwB"}

package/dist/mod.js

@@ -0,0 +1,40 @@
+import { ProbeConfigError, probeUrl } from "@openstatus/health";
+
+//#region src/mod.ts
+/** Probe name when `name` is unset. */
+const typesenseDefaultName = "search";
+/** A probe that expects `GET {host}/health` to answer 2xx with `ok: true`; non-critical by default. Throws `ProbeConfigError` for an invalid `host` or an empty `apiKey`. */
+function typesenseProbe(options) {
+	const doFetch = options.fetch ?? globalThis.fetch;
+	const url = probeUrl({
+		probe: "typesenseProbe",
+		field: "host",
+		value: options.host,
+		path: "/health"
+	});
+	if (options.apiKey != null && options.apiKey.length === 0) throw new ProbeConfigError("typesenseProbe", "apiKey", "must not be empty");
+	const headers = options.apiKey == null ? void 0 : { "x-typesense-api-key": options.apiKey };
+	return {
+		name: options.name ?? typesenseDefaultName,
+		critical: options.critical ?? false,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: async (signal) => {
+			const res = await doFetch(url, {
+				method: "GET",
+				headers,
+				signal
+			});
+			if (!res.ok) {
+				await res.body?.cancel();
+				throw new Error(`unexpected status ${res.status}`);
+			}
+			const body = await res.json().catch(() => null);
+			if (body?.ok !== true) throw new Error(`unexpected health body ${JSON.stringify(body)}`);
+		}
+	};
+}
+
+//#endregion
+export { typesenseDefaultName, typesenseProbe };
+//# sourceMappingURL=mod.js.map

package/dist/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","names":["options: TypesenseProbeOptions","body: { readonly ok?: boolean } | null"],"sources":["../src/mod.ts"],"sourcesContent":["/**\n * Typesense probe for `@openstatus/health`, against `/health`, which must\n * report `ok: true`.\n *\n * ```ts\n * import { typesenseProbe } from \"@openstatus/health-typesense\";\n *\n * const probe = typesenseProbe({ host: env.TYPESENSE_HOST });\n * ```\n *\n * @module\n */\n\nimport {\n  type Probe,\n  ProbeConfigError,\n  type ProbeOverrides,\n  probeUrl,\n} from \"@openstatus/health\";\n\n/** Probe name when `name` is unset. */\nexport const typesenseDefaultName = \"search\";\n\n/** Options for `typesenseProbe()`. */\nexport interface TypesenseProbeOptions extends ProbeOverrides {\n  /** The node URL, e.g. `https://xxx.a1.typesense.net` or `http://localhost:8108`. */\n  readonly host: string | URL;\n  /** An API key, sent as `x-typesense-api-key`. `/health` does not need one. */\n  readonly apiKey?: string;\n  /** Replacement `fetch`, for tests. */\n  readonly fetch?: typeof fetch;\n}\n\n/** A probe that expects `GET {host}/health` to answer 2xx with `ok: true`; non-critical by default. Throws `ProbeConfigError` for an invalid `host` or an empty `apiKey`. */\nexport function typesenseProbe(options: TypesenseProbeOptions): Probe {\n  const doFetch = options.fetch ?? globalThis.fetch;\n  const url = probeUrl({\n    probe: \"typesenseProbe\",\n    field: \"host\",\n    value: options.host,\n    path: \"/health\",\n  });\n  if (options.apiKey != null && options.apiKey.length === 0) {\n    throw new ProbeConfigError(\"typesenseProbe\", \"apiKey\", \"must not be empty\");\n  }\n  const headers = options.apiKey == null\n    ? undefined\n    : { \"x-typesense-api-key\": options.apiKey };\n  return {\n    name: options.name ?? typesenseDefaultName,\n    critical: options.critical ?? false,\n    timeoutMs: options.timeoutMs,\n    skip: options.skip,\n    run: async (signal) => {\n      const res = await doFetch(url, { method: \"GET\", headers, signal });\n      if (!res.ok) {\n        await res.body?.cancel();\n        throw new Error(`unexpected status ${res.status}`);\n      }\n      const body: { readonly ok?: boolean } | null = await res.json()\n        .catch(() => null);\n      if (body?.ok !== true) {\n        throw new Error(`unexpected health body ${JSON.stringify(body)}`);\n      }\n    },\n  };\n}\n"],"mappings":";;;;AAqBA,MAAa,uBAAuB;;AAapC,SAAgB,eAAeA,SAAuC;CACpE,MAAM,UAAU,QAAQ,SAAS,WAAW;CAC5C,MAAM,MAAM,SAAS;EACnB,OAAO;EACP,OAAO;EACP,OAAO,QAAQ;EACf,MAAM;CACP,EAAC;AACF,KAAI,QAAQ,UAAU,QAAQ,QAAQ,OAAO,WAAW,EACtD,OAAM,IAAI,iBAAiB,kBAAkB,UAAU;CAEzD,MAAM,UAAU,QAAQ,UAAU,gBAE9B,EAAE,uBAAuB,QAAQ,OAAQ;AAC7C,QAAO;EACL,MAAM,QAAQ,QAAQ;EACtB,UAAU,QAAQ,YAAY;EAC9B,WAAW,QAAQ;EACnB,MAAM,QAAQ;EACd,KAAK,OAAO,WAAW;GACrB,MAAM,MAAM,MAAM,QAAQ,KAAK;IAAE,QAAQ;IAAO;IAAS;GAAQ,EAAC;AAClE,QAAK,IAAI,IAAI;AACX,UAAM,IAAI,MAAM,QAAQ;AACxB,UAAM,IAAI,OAAO,oBAAoB,IAAI,OAAO;GACjD;GACD,MAAMC,OAAyC,MAAM,IAAI,MAAM,CAC5D,MAAM,MAAM,KAAK;AACpB,OAAI,MAAM,OAAO,KACf,OAAM,IAAI,OAAO,yBAAyB,KAAK,UAAU,KAAK,CAAC;EAElE;CACF;AACF"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@openstatus/health-typesense",
+  "version": "0.1.4-dev.0",
+  "description": "Typesense probe for @openstatus/health",
+  "keywords": [
+    "openstatus",
+    "health",
+    "healthcheck",
+    "typesense",
+    "search"
+  ],
+  "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/typesense/"
+  },
+  "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"
+  },
+  "devDependencies": {
+    "tsdown": "^0.12.7",
+    "typescript": "^5.8.3"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "prepack": "tsdown",
+    "test": "node --experimental-transform-types --test"
+  }
+}